Get Campaigns
GET {{baseUrl}}/api/campaigns/?filter=<string>
Returns some or all campaigns based on filters.
A channel filter is required to list campaigns. Please provide either:
?filter=equals(messages.channel,'email') to list email campaigns, or
?filter=equals(messages.channel,'sms') to list SMS campaigns.
Rate limits:
Burst: 10/s
Steady: 150/m
Scopes:
campaigns:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields[campaign-message] | string | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | |
fields[campaign] | string | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | |
fields[tag] | string | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | |
filter | string | (Required) For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>messages.channel: equals<br>name: contains<br>status: any, equals<br>archived: equals<br>created_at: greater-or-equal, greater-than, less-or-equal, less-than<br>scheduled_at: greater-or-equal, greater-than, less-or-equal, less-than<br>updated_at: greater-or-equal, greater-than, less-or-equal, less-than | |
include | string | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships | |
page[cursor] | string | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | |
sort | string | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Accept | string |
RESPONSES
status: OK
{"data":[{"type":"campaign","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","status":"\u003cstring\u003e","archived":"\u003cboolean\u003e","audiences":{"included":["\u003cstring\u003e","\u003cstring\u003e"],"excluded":["\u003cstring\u003e","\u003cstring\u003e"]},"send_options":{"use_smart_sending":"\u003cboolean\u003e"},"tracking_options":{"is_add_utm":"\u003cboolean\u003e","utm_params":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"is_tracking_clicks":"\u003cboolean\u003e","is_tracking_opens":"\u003cboolean\u003e"},"send_strategy":{"method":"\u003cstring\u003e","options_static":{"datetime":"\u003cdateTime\u003e","is_local":"\u003cboolean\u003e","send_past_recipients_immediately":"\u003cboolean\u003e"},"options_throttled":{"datetime":"\u003cdateTime\u003e","throttle_percentage":"\u003cinteger\u003e"},"options_sto":{"date":"\u003cdate\u003e"}},"created_at":"\u003cdateTime\u003e","scheduled_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e","send_time":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"campaign-messages":{"data":[{"type":"campaign-message","id":"\u003cstring\u003e"},{"type":"campaign-message","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"tags":{"data":[{"type":"tag","id":"\u003cstring\u003e"},{"type":"tag","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}},{"type":"campaign","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","status":"\u003cstring\u003e","archived":"\u003cboolean\u003e","audiences":{"included":["\u003cstring\u003e","\u003cstring\u003e"],"excluded":["\u003cstring\u003e","\u003cstring\u003e"]},"send_options":{"use_smart_sending":"\u003cboolean\u003e"},"tracking_options":{"is_add_utm":"\u003cboolean\u003e","utm_params":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"is_tracking_clicks":"\u003cboolean\u003e","is_tracking_opens":"\u003cboolean\u003e"},"send_strategy":{"method":"\u003cstring\u003e","options_static":{"datetime":"\u003cdateTime\u003e","is_local":"\u003cboolean\u003e","send_past_recipients_immediately":"\u003cboolean\u003e"},"options_throttled":{"datetime":"\u003cdateTime\u003e","throttle_percentage":"\u003cinteger\u003e"},"options_sto":{"date":"\u003cdate\u003e"}},"created_at":"\u003cdateTime\u003e","scheduled_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e","send_time":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"campaign-messages":{"data":[{"type":"campaign-message","id":"\u003cstring\u003e"},{"type":"campaign-message","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"tags":{"data":[{"type":"tag","id":"\u003cstring\u003e"},{"type":"tag","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}],"links":{"self":"\u003curi\u003e","first":"\u003curi\u003e","last":"\u003curi\u003e","prev":"\u003curi\u003e","next":"\u003curi\u003e"},"included":[{"type":"campaign-message","id":"\u003cstring\u003e","attributes":{"label":"\u003cstring\u003e","channel":"\u003cstring\u003e","content":{"subject":"\u003cstring\u003e","preview_text":"\u003cstring\u003e","from_email":"\u003cstring\u003e","from_label":"\u003cstring\u003e","reply_to_email":"\u003cstring\u003e","cc_email":"\u003cstring\u003e","bcc_email":"\u003cstring\u003e"},"send_times":[{"datetime":"\u003cdateTime\u003e","is_local":"\u003cboolean\u003e"},{"datetime":"\u003cdateTime\u003e","is_local":"\u003cboolean\u003e"}],"render_options":{"shorten_links":true,"add_org_prefix":true,"add_info_link":true,"add_opt_out_language":false},"created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"}},{"type":"campaign-message","id":"\u003cstring\u003e","attributes":{"label":"\u003cstring\u003e","channel":"\u003cstring\u003e","content":{"subject":"\u003cstring\u003e","preview_text":"\u003cstring\u003e","from_email":"\u003cstring\u003e","from_label":"\u003cstring\u003e","reply_to_email":"\u003cstring\u003e","cc_email":"\u003cstring\u003e","bcc_email":"\u003cstring\u003e"},"send_times":[{"datetime":"\u003cdateTime\u003e","is_local":"\u003cboolean\u003e"},{"datetime":"\u003cdateTime\u003e","is_local":"\u003cboolean\u003e"}],"render_options":{"shorten_links":true,"add_org_prefix":true,"add_info_link":true,"add_opt_out_language":false},"created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"}}]}