pay groups list
GET {{baseUrl}}/pay-groups
Returns a list of PayGroup 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. | |
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. | |
page_size | number | Number of results to return per page. | |
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":"fd1e0fb5-8f92-4ec9-9f32-179cf732867d","remote_id":"800293","pay_group_name":"contractor","remote_data":[{"path":"qui consectetur aliquip consequat ut","data":{"occaecatc":{}}},{"path":"dolore","data":{"culpa_a":{}}}],"remote_was_deleted":true},{"id":"fd1e0fb5-8f92-4ec9-9f32-179cf732867d","remote_id":"800293","pay_group_name":"contractor","remote_data":[{"path":"id voluptate eu ad","data":{"nostrud78":{},"aliquip_9b7":{}}},{"path":"consequat cupidatat","data":{"ut7b6":{},"pariatur91":{},"anim_2":{}}}],"remote_was_deleted":false}]}