employments list
GET {{baseUrl}}/employments
Returns a list of Employment objects.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
created_after | string | If provided, will only return objects created after this datetime. | |
created_before | string | If provided, will only return objects created before this datetime. | |
cursor | string | The pagination cursor value. | |
employee_id | string | If provided, will only return employments for this employee. | |
expand | string | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | |
include_deleted_data | boolean | Whether to include data that was marked as deleted by third party webhooks. | |
include_remote_data | boolean | Whether to include the original data Merge fetched from the third-party to produce these models. | |
modified_after | string | If provided, will only return objects modified after this datetime. | |
modified_before | string | If provided, will only return objects modified before this datetime. | |
order_by | string | Overrides the default ordering for this endpoint. | |
page_size | number | Number of results to return per page. | |
remote_fields | string | Which fields should be returned in non-normalized form. | |
remote_id | string | The API provider's ID for the given object. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
RESPONSES
status: OK
{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"id":"65d8ffd0-211b-4ba4-b85a-fbe2ce220982","remote_id":"19202938","employee":"0958cbc6-6040-430a-848e-aafacbadf4ae","job_title":"Executive Assistant to Tom Wambsgans","pay_rate":-57796706.7083017,"pay_period":"MONTH","pay_frequency":"WEEKLY","pay_currency":"GQE","pay_group":"d4e4837f-9900-484c-ac40-528365bb08ef","flsa_status":"OWNER","effective_date":"2023-10-06T18:42:34Z","employment_type":"FREELANCE","remote_data":[{"path":"anim sunt eiusmod dolore","data":{"esse236":{},"aute_1":{}}},{"path":"consectetur laborum irure elit","data":{"fugiat0":{},"cupidatat3c":{}}}],"remote_was_deleted":true},{"id":"65d8ffd0-211b-4ba4-b85a-fbe2ce220982","remote_id":"19202938","employee":"0958cbc6-6040-430a-848e-aafacbadf4ae","job_title":"Executive Assistant to Tom Wambsgans","pay_rate":-15982703.932577774,"pay_period":"QUARTER","pay_frequency":"PRO_RATA","pay_currency":"DKK","pay_group":"d4e4837f-9900-484c-ac40-528365bb08ef","flsa_status":"NONEXEMPT","effective_date":"2023-10-06T18:42:34Z","employment_type":"FREELANCE","remote_data":[{"path":"et enim Excepteur in","data":{"incididunt_b":{},"ad99f":{}}},{"path":"esse aliqua ex reprehenderit","data":{"quiea9":{}}}],"remote_was_deleted":false}]}