v1
latestOpenAPI 3.1.02026-07-243113441.2 MBGet compensations for a job
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.
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 By default the API returns only the current compensation - use the include parameter to return all compensations.
scope: compensations:read
Path parameters
The UUID of the job
Query parameters
The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
Number of objects per page. For majority of endpoints will default to 25
Available options:
- all_compensations: Include all effective dated compensations for each job instead of only the current compensation
Headers
Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.
Response
Successful