List

GET {{baseUrl}}/campaigns

Returns a list of your campaigns. The campaigns are returned sorted by creation date, with the most recently created campaigns appearing first.

Request Params

KeyDatatypeRequiredDescription
limitnumber(optional) How many results to return.
includestring(optional) Request that the response include the total count by specifying include=["total_count"].
beforestring(optional) before and after are both optional but only one of them can be in the query at a time.
afterstring(optional) before and after are both optional but only one of them can be in the query at a time.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"data":[{"id":"cmp_e05ee61ff80764b","account_id":"fa9ea650fc7b31a89f92","billing_group_id":"bg_fe3079dcdd80e5ae","name":"My Campaign","description":"My Campaign's description","schedule_type":"immediate","send_date":null,"target_delivery_date":null,"cancel_window_campaign_minutes":60,"metadata":{},"use_type":"marketing","is_draft":true,"deleted":false,"creatives":[],"auto_cancel_if_ncoa":false,"date_created":"2017-09-05T17:47:53.767Z","date_modified":"2017-09-05T17:47:53.767Z","object":"campaign"}],"object":"list","previous_url":null,"next_url":null,"count":1}