groups list
GET {{baseUrl}}/groups
Returns a list of Group 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_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":"134e0111-0f67-44f6-98f0-597000290bb3","remote_id":"800293","parent_group":"2ef51b11-2c4e-4b02-8d1d-50592d9e96ef","name":"COST_CENTER_US","type":"TEAM","remote_data":[{"path":"nulla adipisicing","data":{"officia_cc4":{},"dolor_4_":{},"autef68":{}}},{"path":"nostrud esse","data":{"enima9f":{}}}],"remote_was_deleted":true},{"id":"134e0111-0f67-44f6-98f0-597000290bb3","remote_id":"800293","parent_group":"2ef51b11-2c4e-4b02-8d1d-50592d9e96ef","name":"COST_CENTER_US","type":"COST_CENTER","remote_data":[{"path":"proident aute","data":{"aliquipa":{},"commodo1ee":{},"consectetur_89":{}}},{"path":"deserunt ex et dolor fugiat","data":{"id834":{}}}],"remote_was_deleted":false}]}