automations list
GET {{baseUrl}}/automations
Returns a list of Automation 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":[{"actions":["52ce940b-ecfe-43a6-955f-629f799f7f73"],"name":"Welcome Email","trigger_type":"RECURRENCE","start_date":"2022-12-23T00:00:00Z","end_date":"2022-12-23T00:00:00Z","description":"This sends a welcome email to new customers.","status":"Published","automation_trigger":{"recurrence_schedule":{"days":["Sunday"],"hours":{"type":"send_asap"}},"trigger_settings":{"trigger_event":"NEW_CUSTOMER"}},"id":"e7e11dc0-b31a-2fb6-9dc2-6c5e972d10f3","remote_id":"12"},{"actions":["52ce940b-ecfe-43a6-955f-629f799f7f73"],"name":"Welcome Email","trigger_type":"RECURRENCE","start_date":"2022-12-23T00:00:00Z","end_date":"2022-12-23T00:00:00Z","description":"This sends a welcome email to new customers.","status":"Published","automation_trigger":{"recurrence_schedule":{"days":["Sunday"],"hours":{"type":"send_asap"}},"trigger_settings":{"trigger_event":"NEW_CUSTOMER"}},"id":"urn:uuid:d5e55fa4-58cb-944b-1da2-ec767411e8ef","remote_id":"12"}]}