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

KeyDatatypeRequiredDescription
fields[campaign-message]stringFor more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
fields[campaign]stringFor more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
fields[tag]stringFor more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
filterstring(Required) For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering&lt;br&gt;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
includestringFor more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships
page[cursor]stringFor more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination
sortstringFor more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Acceptstring

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;type&quot;:&quot;campaign&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;attributes&quot;:{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;archived&quot;:&quot;\u003cboolean\u003e&quot;,&quot;audiences&quot;:{&quot;included&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;excluded&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]},&quot;send_options&quot;:{&quot;use_smart_sending&quot;:&quot;\u003cboolean\u003e&quot;},&quot;tracking_options&quot;:{&quot;is_add_utm&quot;:&quot;\u003cboolean\u003e&quot;,&quot;utm_params&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;}],&quot;is_tracking_clicks&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_tracking_opens&quot;:&quot;\u003cboolean\u003e&quot;},&quot;send_strategy&quot;:{&quot;method&quot;:&quot;\u003cstring\u003e&quot;,&quot;options_static&quot;:{&quot;datetime&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;is_local&quot;:&quot;\u003cboolean\u003e&quot;,&quot;send_past_recipients_immediately&quot;:&quot;\u003cboolean\u003e&quot;},&quot;options_throttled&quot;:{&quot;datetime&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;throttle_percentage&quot;:&quot;\u003cinteger\u003e&quot;},&quot;options_sto&quot;:{&quot;date&quot;:&quot;\u003cdate\u003e&quot;}},&quot;created_at&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;scheduled_at&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;send_time&quot;:&quot;\u003cdateTime\u003e&quot;},&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;},&quot;relationships&quot;:{&quot;campaign-messages&quot;:{&quot;data&quot;:[{&quot;type&quot;:&quot;campaign-message&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;},{&quot;type&quot;:&quot;campaign-message&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;}],&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;,&quot;related&quot;:&quot;\u003curi\u003e&quot;}},&quot;tags&quot;:{&quot;data&quot;:[{&quot;type&quot;:&quot;tag&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;},{&quot;type&quot;:&quot;tag&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;}],&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;,&quot;related&quot;:&quot;\u003curi\u003e&quot;}}}},{&quot;type&quot;:&quot;campaign&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;attributes&quot;:{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;archived&quot;:&quot;\u003cboolean\u003e&quot;,&quot;audiences&quot;:{&quot;included&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;excluded&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]},&quot;send_options&quot;:{&quot;use_smart_sending&quot;:&quot;\u003cboolean\u003e&quot;},&quot;tracking_options&quot;:{&quot;is_add_utm&quot;:&quot;\u003cboolean\u003e&quot;,&quot;utm_params&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;}],&quot;is_tracking_clicks&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_tracking_opens&quot;:&quot;\u003cboolean\u003e&quot;},&quot;send_strategy&quot;:{&quot;method&quot;:&quot;\u003cstring\u003e&quot;,&quot;options_static&quot;:{&quot;datetime&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;is_local&quot;:&quot;\u003cboolean\u003e&quot;,&quot;send_past_recipients_immediately&quot;:&quot;\u003cboolean\u003e&quot;},&quot;options_throttled&quot;:{&quot;datetime&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;throttle_percentage&quot;:&quot;\u003cinteger\u003e&quot;},&quot;options_sto&quot;:{&quot;date&quot;:&quot;\u003cdate\u003e&quot;}},&quot;created_at&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;scheduled_at&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;send_time&quot;:&quot;\u003cdateTime\u003e&quot;},&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;},&quot;relationships&quot;:{&quot;campaign-messages&quot;:{&quot;data&quot;:[{&quot;type&quot;:&quot;campaign-message&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;},{&quot;type&quot;:&quot;campaign-message&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;}],&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;,&quot;related&quot;:&quot;\u003curi\u003e&quot;}},&quot;tags&quot;:{&quot;data&quot;:[{&quot;type&quot;:&quot;tag&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;},{&quot;type&quot;:&quot;tag&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;}],&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;,&quot;related&quot;:&quot;\u003curi\u003e&quot;}}}}],&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;,&quot;first&quot;:&quot;\u003curi\u003e&quot;,&quot;last&quot;:&quot;\u003curi\u003e&quot;,&quot;prev&quot;:&quot;\u003curi\u003e&quot;,&quot;next&quot;:&quot;\u003curi\u003e&quot;},&quot;included&quot;:[{&quot;type&quot;:&quot;campaign-message&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;attributes&quot;:{&quot;label&quot;:&quot;\u003cstring\u003e&quot;,&quot;channel&quot;:&quot;\u003cstring\u003e&quot;,&quot;content&quot;:{&quot;subject&quot;:&quot;\u003cstring\u003e&quot;,&quot;preview_text&quot;:&quot;\u003cstring\u003e&quot;,&quot;from_email&quot;:&quot;\u003cstring\u003e&quot;,&quot;from_label&quot;:&quot;\u003cstring\u003e&quot;,&quot;reply_to_email&quot;:&quot;\u003cstring\u003e&quot;,&quot;cc_email&quot;:&quot;\u003cstring\u003e&quot;,&quot;bcc_email&quot;:&quot;\u003cstring\u003e&quot;},&quot;send_times&quot;:[{&quot;datetime&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;is_local&quot;:&quot;\u003cboolean\u003e&quot;},{&quot;datetime&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;is_local&quot;:&quot;\u003cboolean\u003e&quot;}],&quot;render_options&quot;:{&quot;shorten_links&quot;:true,&quot;add_org_prefix&quot;:true,&quot;add_info_link&quot;:true,&quot;add_opt_out_language&quot;:false},&quot;created_at&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cdateTime\u003e&quot;},&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;}},{&quot;type&quot;:&quot;campaign-message&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;attributes&quot;:{&quot;label&quot;:&quot;\u003cstring\u003e&quot;,&quot;channel&quot;:&quot;\u003cstring\u003e&quot;,&quot;content&quot;:{&quot;subject&quot;:&quot;\u003cstring\u003e&quot;,&quot;preview_text&quot;:&quot;\u003cstring\u003e&quot;,&quot;from_email&quot;:&quot;\u003cstring\u003e&quot;,&quot;from_label&quot;:&quot;\u003cstring\u003e&quot;,&quot;reply_to_email&quot;:&quot;\u003cstring\u003e&quot;,&quot;cc_email&quot;:&quot;\u003cstring\u003e&quot;,&quot;bcc_email&quot;:&quot;\u003cstring\u003e&quot;},&quot;send_times&quot;:[{&quot;datetime&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;is_local&quot;:&quot;\u003cboolean\u003e&quot;},{&quot;datetime&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;is_local&quot;:&quot;\u003cboolean\u003e&quot;}],&quot;render_options&quot;:{&quot;shorten_links&quot;:true,&quot;add_org_prefix&quot;:true,&quot;add_info_link&quot;:true,&quot;add_opt_out_language&quot;:false},&quot;created_at&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cdateTime\u003e&quot;},&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;}}]}