engagements list
GET {{baseUrl}}/engagements
Returns a list of Engagement 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. | |
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. | |
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":"2d52d099-bc0e-f0a7-0e8a-046802ecfb6c","remote_id":"19202938","owner":"0358cbc6-2040-430a-848e-aafacbadf3aa","content":"Call for negotiation","subject":"Call from customer","direction":"INBOUND","engagement_type":"0358cbc6-2040-430a-848e-aafacbadf3aa","start_time":"2022-02-10T00:00:00Z","end_time":"2022-02-10T00:05:00Z","account":"5de3d88e-da45-3df4-d212-65e6f8d7c4db","remote_data":[{"path":"voluptate in laboris in","data":{"proident_218":{}}},{"path":"consec","data":{"labore_9":{},"aliquip_":{}}}],"remote_was_deleted":false},{"id":"349f2d7e-a772-2b73-58fc-ca489394a959","remote_id":"19202938","owner":"0358cbc6-2040-430a-848e-aafacbadf3aa","content":"Call for negotiation","subject":"Call from customer","direction":"INBOUND","engagement_type":"0358cbc6-2040-430a-848e-aafacbadf3aa","start_time":"2022-02-10T00:00:00Z","end_time":"2022-02-10T00:05:00Z","account":"30419eb4-d3a0-e5b2-9c58-859f0d6b6bad","remote_data":[{"path":"in fug","data":{"irure_8":{}}},{"path":"in ullamco nulla","data":{"laborum_4":{},"pariatur8":{}}}],"remote_was_deleted":false}]}