campaigns list
GET {{baseUrl}}/campaigns
Returns a list of Campaign 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":[{"name":"New Customer Campaign","unique_opens":-1547534230,"remote_created_at":"2022-12-23T00:00:00Z","emails_sent":-447860233,"id":"urn:uuid:8d4a33cc-ab69-bb49-1f88-3573b5875f65","remote_id":"30"},{"name":"New Customer Campaign","unique_opens":445511671,"remote_created_at":"2022-12-23T00:00:00Z","emails_sent":-649078042,"id":"urn:uuid:504156f5-2ff5-d756-6cfe-c90944a2e288","remote_id":"30"}]}