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.
Note: Currently the API does not support creating multiple compensations per job - creating a compensation with the same job_uuid as another will fail with a relevant error.
Use flsa_status to determine if an employee is eligible for overtime.
scope: jobs:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page | string | The page that is requested. When unspecified, will load all objects unless endpoint forces pagination. | |
per | string | Number of objects per page. For majority of endpoints will default to 25 | |
include | string | Available options: |
- all_compensations: Include all effective dated compensations for each job instead of only the current compensation |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Gusto-API-Version | string | Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used. | |
Accept | string |
RESPONSES
status: OK
[{"uuid":"db57832c-d8bc-43a7-ae99-0a04480ff037","employee_uuid":"be3c9d35-f17d-4431-8a90-a6537f17dfde","version":"98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872","job_uuid":"d8f8fbe7-496d-4b69-86f0-1e2d1b73a086","rate":"70.00","payment_unit":"Hour","flsa_status":"Nonexempt","effective_date":"2020-12-11","adjust_for_minimum_wage":false,"minimum_wages":[]},{"id":1363316536327003,"employee_uuid":"be3c9d35-f17d-4431-8a90-a6537f17dfd3","job_id":1123581321345589,"uuid":"a4d9ba9c-32cc-4cc1-a5bc-6ef4cd653e7a","version":"cc59bd3879d655fb940a1f6b675f2ad9","job_uuid":"d8f8fbe7-496d-4b69-86f0-1e2d1b73a086","payment_unit":"Hour","flsa_status":"Nonexempt","effective_date":"2018-12-11","rate":"5.00","adjust_for_minimum_wage":true,"minimum_wages":[{"uuid":"edeea5af-ecd6-4b1c-b5de-5cff2d302738","wage":"7.25","effective_date":"2018-12-11"}]}]