Get compensations for a job

GET {{baseUrl}}/v1/jobs/:job_id/compensations?page=<number>&per=<number>&include=<string>

Compensations contain information on how much is paid out for a job. Jobs may have many compensations, but only one that is active. The current compensation is the one with the most recent effective_date. By default the API returns only the current compensation - see the include query parameter for retrieving all compensations.

Use flsa_status to determine if an employee is eligible for overtime.

scope: jobs:read

Request Params

KeyDatatypeRequiredDescription
pagestringThe page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
perstringNumber of objects per page. For majority of endpoints will default to 25
includestringAvailable options:
  • all_compensations: Include all effective dated compensations for each job instead of only the current compensation |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

[{&quot;id&quot;:1363316536327004,&quot;uuid&quot;:&quot;db57832c-d8bc-43a7-ae99-0a04480ff037&quot;,&quot;employee_uuid&quot;:&quot;be3c9d35-f17d-4431-8a90-a6537f17dfde&quot;,&quot;version&quot;:&quot;98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872&quot;,&quot;job_id&quot;:1123581321345589,&quot;job_uuid&quot;:&quot;d8f8fbe7-496d-4b69-86f0-1e2d1b73a086&quot;,&quot;rate&quot;:&quot;70.00&quot;,&quot;payment_unit&quot;:&quot;Hour&quot;,&quot;flsa_status&quot;:&quot;Nonexempt&quot;,&quot;effective_date&quot;:&quot;2020-12-11&quot;,&quot;adjust_for_minimum_wage&quot;:false,&quot;minimum_wages&quot;:[]},{&quot;id&quot;:1363316536327003,&quot;uuid&quot;:&quot;a4d9ba9c-32cc-4cc1-a5bc-6ef4cd653e7a&quot;,&quot;employee_uuid&quot;:&quot;be3c9d35-f17d-4431-8a90-a6537f17dfd3&quot;,&quot;version&quot;:&quot;cc59bd3879d655fb940a1f6b675f2ad9&quot;,&quot;job_id&quot;:1123581321345589,&quot;job_uuid&quot;:&quot;d8f8fbe7-496d-4b69-86f0-1e2d1b73a086&quot;,&quot;rate&quot;:&quot;5.00&quot;,&quot;payment_unit&quot;:&quot;Hour&quot;,&quot;flsa_status&quot;:&quot;Nonexempt&quot;,&quot;effective_date&quot;:&quot;2018-12-11&quot;,&quot;adjust_for_minimum_wage&quot;:true,&quot;minimum_wages&quot;:[{&quot;uuid&quot;:&quot;edeea5af-ecd6-4b1c-b5de-5cff2d302738&quot;,&quot;wage&quot;:&quot;7.25&quot;,&quot;effective_date&quot;:&quot;2018-12-11&quot;}]}]