Klaviyo API
The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
Endpoints 400
Accounts
- GETGet Accounts
/api/accounts?fields[account]=contact_informationRetrieve the account(s) associated with a given private API key. This will return 1 account object within the array. You can use this to retrieve… - GETGet Account
/api/accounts/:id?fields[account]=contact_informationRetrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate…
Billing
- GETList Billing Usage
/api/billing-usage?fields[billing-usage]=as_of&filter=any(id,['email_sends', 'customer_hub_active_profiles'])List current-period usage and plan caps for the account.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: usage:read OpenAPI Spec - GETGet Billing Usage
/api/billing-usage/:id?fields[billing-usage]=as_ofGet current-period usage and plan cap for a single usage type.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: usage:read OpenAPI Spec
Brands
- GETGet Brand Logos
/api/brand-logos?fields[brand-logo]=alt_text&fields[image]=format&include=imageGet all brand logos for the authenticated account.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: brands:read OpenAPI Spec - POSTCreate Brand Logo
/api/brand-logos?fields[brand-logo]=alt_textCreate a new brand logo.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: brands:write OpenAPI Spec - GETGet Brand Logo
/api/brand-logos/:id?fields[brand-logo]=alt_text&fields[image]=format&include=imageGet the brand logo with the given ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: brands:read OpenAPI Spec - DELETEDelete Brand Logo
/api/brand-logos/:idDelete the brand logo with the given ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: brands:write OpenAPI Spec - PATCHUpdate Brand Logo
/api/brand-logos/:id?fields[brand-logo]=alt_textUpdate the brand logo with the given ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: brands:write OpenAPI Spec - GETGet Brand Buttons
/api/brand-buttons?fields[brand-button]=borderGet all brand buttons for the authenticated account.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: brands:read OpenAPI Spec - POSTCreate Brand Button
/api/brand-buttons?fields[brand-button]=borderCreate a new brand button.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: brands:write OpenAPI Spec - GETGet Brand Button
/api/brand-buttons/:id?fields[brand-button]=borderGet the brand button with the given ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: brands:read OpenAPI Spec - DELETEDelete Brand Button
/api/brand-buttons/:idDelete the brand button with the given ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: brands:write OpenAPI Spec - PATCHUpdate Brand Button
/api/brand-buttons/:id?fields[brand-button]=borderUpdate the brand button with the given ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: brands:write OpenAPI Spec - GETGet Brand Colors
/api/brand-colors?fields[brand-color]=colorsGet all brand color groups for the authenticated account.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: brands:read OpenAPI Spec - POSTCreate Brand Color
/api/brand-colors?fields[brand-color]=colorsCreate a new brand color group.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: brands:write OpenAPI Spec - GETGet Brand Color
/api/brand-colors/:id?fields[brand-color]=colorsGet the brand color group with the given ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: brands:read OpenAPI Spec - DELETEDelete Brand Color
/api/brand-colors/:idDelete the brand color group with the given ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: brands:write OpenAPI Spec - PATCHUpdate Brand Color
/api/brand-colors/:id?fields[brand-color]=colorsUpdate the brand color group with the given ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: brands:write OpenAPI Spec - GETGet Brand Voice
/api/brand-voice/:id?fields[brand-voice]=idGet the brand voice for the authenticated company.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: brands:read OpenAPI Spec - PATCHUpdate Brand Voice
/api/brand-voice/:id?fields[brand-voice]=idUpdate the brand voice for the authenticated company.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: brands:write OpenAPI Spec - GETGet Brand Social Groups
/api/brand-social-groups?fields[brand-social-group]=idGet all brand social groups for the authenticated account.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: brands:read OpenAPI Spec - POSTCreate Brand Social Group
/api/brand-social-groups?fields[brand-social-group]=idCreate a new brand social group.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: brands:write OpenAPI Spec - GETGet Brand Social Group
/api/brand-social-groups/:id?fields[brand-social-group]=idGet the brand social group with the given ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: brands:read OpenAPI Spec - DELETEDelete Brand Social Group
/api/brand-social-groups/:idDelete the brand social group with the given ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: brands:write OpenAPI Spec - PATCHUpdate Brand Social Group
/api/brand-social-groups/:id?fields[brand-social-group]=idUpdate the brand social group with the given ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: brands:write OpenAPI Spec - GETGet Brand Email Defaults
/api/brand-email-defaults?fields[brand-button]=border&fields[brand-email-default]=body&fields[brand-logo]=alt_text&fields[brand-social-group]=id&include=brand-buttonList the brand email defaults for the authenticated account.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: brands:read OpenAPI Spec - GETGet Brand Email Default
/api/brand-email-defaults/:id?fields[brand-button]=border&fields[brand-email-default]=body&fields[brand-logo]=alt_text&fields[brand-social-group]=id&include=brand-buttonGet the brand email defaults for the authenticated account.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: brands:read OpenAPI Spec - PATCHUpdate Brand Email Default
/api/brand-email-defaults/:id?fields[brand-email-default]=bodyPartial update of the brand email defaults for the authenticated account.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: brands:write OpenAPI Spec
Campaigns
- GETGet Campaigns
/api/campaigns?fields[campaign-audience]=created&fields[campaign-message]=created&fields[campaign]=created_at&fields[tag]=id&filter=any(id,['example'])&include=campaign-audiences&page[cursor]=string&page[size]=100&sort=created_atGet all campaigns, with optional filtering.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - POSTCreate Campaign
/api/campaigns?fields[campaign]=created_atCreate a campaign with inline audiences, messages, and variations.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write OpenAPI Spec - GETGet Campaign
/api/campaigns/:id?fields[campaign-audience]=created&fields[campaign-message]=created&fields[campaign]=created_at&fields[tag]=id&include=campaign-audiencesGet a campaign by ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - DELETEDelete Campaign
/api/campaigns/:idDelete a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write OpenAPI Spec - PATCHUpdate Campaign
/api/campaigns/:id?fields[campaign]=created_atUpdate a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write OpenAPI Spec - GETGet Campaign Messages
/api/campaign-messages?fields[campaign-message]=created&fields[campaign]=created_at&filter=equals(id,'example')&include=campaign&page[cursor]=string&page[size]=20&sort=createdReturns campaign messages based on filters.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - POSTCreate Campaign Message
/api/campaign-messages?fields[campaign-message]=createdCreate a campaign message.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write OpenAPI Spec - GETGet Campaign Message
/api/campaign-messages/:id?fields[campaign-message]=created&fields[campaign-variation]=created&fields[campaign]=created_at&include=campaignGet a campaign message by ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - DELETEDelete Campaign Message
/api/campaign-messages/:idDelete a campaign message.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write OpenAPI Spec - PATCHUpdate Campaign Message
/api/campaign-messages/:id?fields[campaign-message]=createdUpdate a campaign message.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write OpenAPI Spec - GETGet Campaign Send Job
/api/campaign-send-jobs/:id?fields[campaign-send-job]=idGet a campaign send job<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - PATCHCancel Campaign Send
/api/campaign-send-jobs/:idPermanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT<br><br>*Rate limits*:<br>Burst:… - GETGet Campaign Recipient Estimation Job
/api/campaign-recipient-estimation-jobs/:id?fields[campaign-recipient-estimation-job]=idRetrieve the status of a recipient estimation job triggered with the Create Campaign Recipient Estimation Job endpoint.<br><br>*Rate limits*:<br>Burst:… - GETGet Campaign Recipient Estimation
/api/campaign-recipient-estimations/:id?fields[campaign-recipient-estimation]=estimated_recipient_countGet the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the Create Campaign Recipient Estimation… - GETGet Campaign Audience
/api/campaign-audiences/:id?fields[campaign-audience]=created&fields[campaign-message]=created&fields[campaign]=created_at&include=campaignGet the campaign audience with the given ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - DELETEDelete Campaign Audience
/api/campaign-audiences/:idDelete the campaign audience with the given ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write OpenAPI Spec - PATCHUpdate Campaign Audience
/api/campaign-audiences/:id?fields[campaign-audience]=createdUpdate the campaign audience with the given ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write OpenAPI Spec - GETGet Campaign Variation
/api/campaign-variations/:id?fields[campaign-message]=created&fields[campaign-variation]=created&fields[image]=format&fields[translation]=channel&include=campaign-messageGet the campaign variation with the given ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - DELETEDelete Campaign Variation
/api/campaign-variations/:idDelete the campaign variation with the given ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write OpenAPI Spec - PATCHUpdate Campaign Variation
/api/campaign-variations/:id?fields[campaign-variation]=createdUpdate the campaign variation with the given ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write OpenAPI Spec - POSTClone Campaign
/api/campaign-clone?fields[campaign]=created_atClones an existing campaign, returning a new campaign based on the original with a new ID and name.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m… - POSTAssign Template to Campaign Message
/api/campaign-message-assign-template?fields[campaign-message]=channelCreates a non-reusable version of the template and assigns it to the message.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write… - POSTSend Campaign
/api/campaign-send-jobs?fields[campaign-send-job]=idTrigger a campaign to send asynchronously<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write OpenAPI Spec - POSTRefresh Campaign Recipient Estimation
/api/campaign-recipient-estimation-jobs?fields[campaign-recipient-estimation-job]=idTrigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the Get Campaign Recipient Estimation Job endpoint to… - POSTCreate Campaign Audience
/api/campaign-audiences?fields[campaign-audience]=createdCreate a campaign audience.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write OpenAPI Spec - POSTClone Campaign Audience
/api/campaign-audience-clone?fields[campaign-audience]=createdClone an existing campaign audience to a target campaign.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write OpenAPI Spec - POSTClone Campaign Message
/api/campaign-message-clone?fields[campaign-message]=createdClone an existing campaign message to a target audience.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write OpenAPI Spec - POSTCreate Campaign Variation
/api/campaign-variations?fields[campaign-variation]=createdCreate a campaign variation.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write OpenAPI Spec - POSTSchedule Campaign Message
/api/campaign-message-schedule?fields[campaign-message-schedule]=idSchedule a single campaign message.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write OpenAPI Spec - PATCHUpdate Campaign Message Schedule
/api/campaign-message-schedule/:idCancel or revert a scheduled campaign message.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write OpenAPI Spec - GETGet Campaign for Campaign Message
/api/campaign-messages/:id/campaign?fields[campaign]=created_atReturn the related omnicampaign<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - GETGet Campaign ID for Campaign Message
/api/campaign-messages/:id/relationships/campaignReturns the ID of the related omnicampaign<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - GETGet Template for Campaign Message
/api/campaign-messages/:id/template?fields[template]=ampReturn the related template<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read templates:read OpenAPI Spec - GETGet Template ID for Campaign Message
/api/campaign-messages/:id/relationships/templateReturns the ID of the related template<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read templates:read OpenAPI Spec - GETGet Image for Campaign Message
/api/campaign-messages/:id/image?fields[image]=formatReturn the related image for a given campaign message<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read images:read OpenAPI Spec - GETGet Image ID for Campaign Message
/api/campaign-messages/:id/relationships/imageReturns the ID of the related image<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read images:read OpenAPI Spec - PATCHUpdate Image for Campaign Message
/api/campaign-messages/:id/relationships/imageUpdate a campaign message image<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:write images:read OpenAPI Spec - GETGet Audience for Campaign Message
/api/campaign-messages/:id/campaign-audience?fields[campaign-audience]=createdGet the campaign audience for the given campaign message ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - GETGet Audience ID for Campaign Message
/api/campaign-messages/:id/relationships/campaign-audienceGet the campaign audience relationship for the given campaign message ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI… - GETGet Tags for Campaign
/api/campaigns/:id/tags?fields[tag]=idGet the tags on the given campaign ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: campaigns:read tags:read OpenAPI Spec - GETGet Tag IDs for Campaign
/api/campaigns/:id/relationships/tagsGet all tag relationships for the given campaign ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: campaigns:read tags:read OpenAPI Spec - GETGet Tags for Campaign Message
/api/campaign-messages/:id/tags?fields[tag]=idGet all tags for the given campaign message ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: campaigns:read tags:read OpenAPI Spec - GETGet Tag IDs for Campaign Message
/api/campaign-messages/:id/relationships/tagsGet all tag relationships for the given campaign message ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: campaigns:read tags:read OpenAPI Spec - GETGet Messages for Campaign
/api/campaigns/:id/campaign-messages?fields[campaign-message]=created&fields[campaign]=created_at&include=campaign&page[cursor]=stringGet all messages for the given campaign.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - GETGet Message IDs for Campaign
/api/campaigns/:id/relationships/campaign-messages?page[cursor]=stringGet all campaign message relationships for the given campaign ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - GETGet Campaign Audiences for Campaign
/api/campaigns/:id/campaign-audiences?fields[campaign-audience]=createdGet all campaign audiences for the given campaign ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - GETGet Audience IDs for Campaign
/api/campaigns/:id/relationships/campaign-audiencesGet all campaign audience relationships for the given campaign ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - GETGet Campaign for Campaign Audience
/api/campaign-audiences/:id/campaign?fields[campaign]=created_atGet the campaign for the given campaign audience ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - GETGet Campaign ID for Campaign Audience
/api/campaign-audiences/:id/relationships/campaignGet the campaign relationship for the given campaign audience ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - GETGet Campaign Messages for Campaign Audience
/api/campaign-audiences/:id/campaign-messages?fields[campaign-message]=created&page[cursor]=stringGet all campaign messages for the given campaign audience ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - GETGet Message IDs for Campaign Audience
/api/campaign-audiences/:id/relationships/campaign-messages?page[cursor]=stringGet all campaign messages relationships for the given campaign audience ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read… - GETGet Message for Campaign Variation
/api/campaign-variations/:id/campaign-message?fields[campaign-message]=createdGet the campaign message for the given campaign variation ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - GETGet Message ID for Campaign Variation
/api/campaign-variations/:id/relationships/campaign-messageGet the campaign message relationship for the given campaign variation ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read… - GETGet Translation for Campaign Variation
/api/campaign-variations/:id/translation?fields[translation]=channelGet the translation for the given campaign variation ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - GETGet Translation ID for Campaign Variation
/api/campaign-variations/:id/relationships/translationGet the translation relationship for the given campaign variation ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - GETGet Image for Campaign Variation
/api/campaign-variations/:id/image?fields[image]=formatGet the image for the given campaign variation ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - GETGet Image ID for Campaign Variation
/api/campaign-variations/:id/relationships/imageGet the image relationship for the given campaign variation ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - GETGet Variations for Campaign Message
/api/campaign-messages/:id/campaign-variations?fields[campaign-variation]=createdGet all campaign variations for the given campaign message ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read OpenAPI Spec - GETGet Variation IDs for Campaign Message
/api/campaign-messages/:id/relationships/campaign-variationsGet all campaign variation relationships for the given campaign message ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: campaigns:read…
Catalogs
- GETGet Catalog Items
/api/catalog-items?fields[catalog-item]=created&fields[catalog-variant]=created&filter=any(ids,['$custom:::$default:::SAMPLE-DATA-ITEM-1'])&include=variants&page[cursor]=string&page[size]=100&sort=createdGet all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: created Currently, the only… - POSTCreate Catalog Item
/api/catalog-items?fields[catalog-item]=createdCreate a new catalog item.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: catalogs:write OpenAPI Spec - GETGet Catalog Item
/api/catalog-items/:id?fields[catalog-item]=created&fields[catalog-variant]=created&include=variantsGet a specific catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady: 3500/m Scopes: catalogs:read OpenAPI Spec - DELETEDelete Catalog Item
/api/catalog-items/:idDelete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: catalogs:write OpenAPI Spec - PATCHUpdate Catalog Item
/api/catalog-items/:id?fields[catalog-item]=createdUpdate a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: catalogs:write OpenAPI Spec - GETGet Catalog Variants
/api/catalog-variants?fields[catalog-variant]=created&filter=any(ids,['$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM'])&page[cursor]=string&page[size]=100&sort=createdGet all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: created Currently, the only supported… - POSTCreate Catalog Variant
/api/catalog-variants?fields[catalog-variant]=createdCreate a new variant for a related catalog item.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: catalogs:write OpenAPI Spec - GETGet Catalog Variant
/api/catalog-variants/:id?fields[catalog-variant]=createdGet a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady: 3500/m Scopes: catalogs:read OpenAPI Spec - DELETEDelete Catalog Variant
/api/catalog-variants/:idDelete a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: catalogs:write OpenAPI Spec - PATCHUpdate Catalog Variant
/api/catalog-variants/:id?fields[catalog-variant]=createdUpdate a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: catalogs:write OpenAPI Spec - GETGet Catalog Categories
/api/catalog-categories?fields[catalog-category]=external_id&filter=any(ids,['$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL'])&page[cursor]=string&page[size]=100&sort=createdGet all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: created Currently, the… - POSTCreate Catalog Category
/api/catalog-categories?fields[catalog-category]=external_idCreate a new catalog category.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: catalogs:write OpenAPI Spec - GETGet Catalog Category
/api/catalog-categories/:id?fields[catalog-category]=external_idGet a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady: 3500/m Scopes: catalogs:read OpenAPI Spec - DELETEDelete Catalog Category
/api/catalog-categories/:idDelete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: catalogs:write OpenAPI Spec - PATCHUpdate Catalog Category
/api/catalog-categories/:id?fields[catalog-category]=external_idUpdate a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: catalogs:write OpenAPI Spec - GETGet Bulk Create Catalog Items Jobs
/api/catalog-item-bulk-create-jobs?fields[catalog-item-bulk-create-job]=completed_at&filter=equals(status,'processing')&page[cursor]=stringGet all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: catalogs:read… - POSTBulk Create Catalog Items
/api/catalog-item-bulk-create-jobs?fields[catalog-item-bulk-create-job]=completed_atCreate a catalog item bulk create job to create a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is… - GETGet Bulk Create Catalog Items Job
/api/catalog-item-bulk-create-jobs/:job_id?fields[catalog-item-bulk-create-job]=completed_at&fields[catalog-item]=created&include=itemsGet a catalog item bulk create job with the given job ID. An include parameter can be provided to get the following related resource data: items.<br><br>*Rate… - GETGet Bulk Update Catalog Items Jobs
/api/catalog-item-bulk-update-jobs?fields[catalog-item-bulk-update-job]=completed_at&filter=equals(status,'processing')&page[cursor]=stringGet all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: catalogs:read… - POSTBulk Update Catalog Items
/api/catalog-item-bulk-update-jobs?fields[catalog-item-bulk-update-job]=completed_atCreate a catalog item bulk update job to update a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is… - GETGet Bulk Update Catalog Items Job
/api/catalog-item-bulk-update-jobs/:job_id?fields[catalog-item-bulk-update-job]=completed_at&fields[catalog-item]=created&include=itemsGet a catalog item bulk update job with the given job ID. An include parameter can be provided to get the following related resource data: items.<br><br>*Rate… - GETGet Bulk Delete Catalog Items Jobs
/api/catalog-item-bulk-delete-jobs?fields[catalog-item-bulk-delete-job]=completed_at&filter=equals(status,'processing')&page[cursor]=stringGet all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady: 3500/m Scopes:… - POSTBulk Delete Catalog Items
/api/catalog-item-bulk-delete-jobs?fields[catalog-item-bulk-delete-job]=completed_atCreate a catalog item bulk delete job to delete a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is… - GETGet Bulk Delete Catalog Items Job
/api/catalog-item-bulk-delete-jobs/:job_id?fields[catalog-item-bulk-delete-job]=completed_atGet a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady: 3500/m Scopes: catalogs:read OpenAPI Spec - GETGet Bulk Create Variants Jobs
/api/catalog-variant-bulk-create-jobs?fields[catalog-variant-bulk-create-job]=completed_at&filter=equals(status,'processing')&page[cursor]=stringGet all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes:… - POSTBulk Create Catalog Variants
/api/catalog-variant-bulk-create-jobs?fields[catalog-variant-bulk-create-job]=completed_atCreate a catalog variant bulk create job to create a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload… - GETGet Bulk Create Variants Job
/api/catalog-variant-bulk-create-jobs/:job_id?fields[catalog-variant-bulk-create-job]=completed_at&fields[catalog-variant]=created&include=variantsGet a catalog variant bulk create job with the given job ID. An include parameter can be provided to get the following related resource data:… - GETGet Bulk Update Variants Jobs
/api/catalog-variant-bulk-update-jobs?fields[catalog-variant-bulk-update-job]=completed_at&filter=equals(status,'processing')&page[cursor]=stringGet all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes:… - POSTBulk Update Catalog Variants
/api/catalog-variant-bulk-update-jobs?fields[catalog-variant-bulk-update-job]=completed_atCreate a catalog variant bulk update job to update a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload… - GETGet Bulk Update Variants Job
/api/catalog-variant-bulk-update-jobs/:job_id?fields[catalog-variant-bulk-update-job]=completed_at&fields[catalog-variant]=created&include=variantsGet a catalog variate bulk update job with the given job ID. An include parameter can be provided to get the following related resource data:… - GETGet Bulk Delete Variants Jobs
/api/catalog-variant-bulk-delete-jobs?fields[catalog-variant-bulk-delete-job]=completed_at&filter=equals(status,'processing')&page[cursor]=stringGet all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady: 3500/m Scopes:… - POSTBulk Delete Catalog Variants
/api/catalog-variant-bulk-delete-jobs?fields[catalog-variant-bulk-delete-job]=completed_atCreate a catalog variant bulk delete job to delete a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload… - GETGet Bulk Delete Variants Job
/api/catalog-variant-bulk-delete-jobs/:job_id?fields[catalog-variant-bulk-delete-job]=completed_atGet a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady: 3500/m Scopes: catalogs:read OpenAPI Spec - GETGet Bulk Create Categories Jobs
/api/catalog-category-bulk-create-jobs?fields[catalog-category-bulk-create-job]=completed_at&filter=equals(status,'processing')&page[cursor]=stringGet all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady: 3500/m Scopes:… - POSTBulk Create Catalog Categories
/api/catalog-category-bulk-create-jobs?fields[catalog-category-bulk-create-job]=completed_atCreate a catalog category bulk create job to create a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed… - GETGet Bulk Create Categories Job
/api/catalog-category-bulk-create-jobs/:job_id?fields[catalog-category-bulk-create-job]=completed_at&fields[catalog-category]=external_id&include=categoriesGet a catalog category bulk create job with the given job ID. An include parameter can be provided to get the following related resource data:… - GETGet Bulk Update Categories Jobs
/api/catalog-category-bulk-update-jobs?fields[catalog-category-bulk-update-job]=completed_at&filter=equals(status,'processing')&page[cursor]=stringGet all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady: 3500/m Scopes:… - POSTBulk Update Catalog Categories
/api/catalog-category-bulk-update-jobs?fields[catalog-category-bulk-update-job]=completed_atCreate a catalog category bulk update job to update a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed… - GETGet Bulk Update Categories Job
/api/catalog-category-bulk-update-jobs/:job_id?fields[catalog-category-bulk-update-job]=completed_at&fields[catalog-category]=external_id&include=categoriesGet a catalog category bulk update job with the given job ID. An include parameter can be provided to get the following related resource data:… - GETGet Bulk Delete Categories Jobs
/api/catalog-category-bulk-delete-jobs?fields[catalog-category-bulk-delete-job]=completed_at&filter=equals(status,'processing')&page[cursor]=stringGet all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady: 3500/m Scopes:… - POSTBulk Delete Catalog Categories
/api/catalog-category-bulk-delete-jobs?fields[catalog-category-bulk-delete-job]=completed_atCreate a catalog category bulk delete job to delete a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed… - GETGet Bulk Delete Categories Job
/api/catalog-category-bulk-delete-jobs/:job_id?fields[catalog-category-bulk-delete-job]=completed_atGet a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady: 3500/m Scopes: catalogs:read OpenAPI Spec - POSTCreate Back In Stock Subscription
/api/back-in-stock-subscriptionsSubscribe a profile to receive back in stock notifications. Check out our Back in Stock API guide for more details. This endpoint is specifically designed to… - GETGet Items for Catalog Category
/api/catalog-categories/:id/items?fields[catalog-item]=created&fields[catalog-variant]=created&filter=any(ids,['$custom:::$default:::SAMPLE-DATA-ITEM-1'])&include=variants&page[cursor]=string&page[size]=100&sort=createdGet all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: created Returns a… - GETGet Item IDs for Catalog Category
/api/catalog-categories/:id/relationships/items?filter=any(ids,['$custom:::$default:::SAMPLE-DATA-ITEM-1'])&page[cursor]=string&page[size]=100&sort=createdGet all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady: 3500/m Scopes:… - POSTAdd Items to Catalog Category
/api/catalog-categories/:id/relationships/itemsCreate a new item relationship for the given category ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: catalogs:write OpenAPI Spec - DELETERemove Items from Catalog Category
/api/catalog-categories/:id/relationships/itemsDelete item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: catalogs:write OpenAPI Spec - PATCHUpdate Items for Catalog Category
/api/catalog-categories/:id/relationships/itemsUpdate item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: catalogs:write OpenAPI Spec - GETGet Variants for Catalog Item
/api/catalog-items/:id/variants?fields[catalog-variant]=created&filter=any(ids,['$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM'])&page[cursor]=string&page[size]=100&sort=createdGet all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: created Returns a maximum of… - GETGet Variant IDs for Catalog Item
/api/catalog-items/:id/relationships/variants?filter=any(ids,['$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM'])&page[cursor]=string&page[size]=100&sort=createdGet all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: created Returns a maximum of… - GETGet Categories for Catalog Item
/api/catalog-items/:id/categories?fields[catalog-category]=external_id&filter=any(ids,['$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL'])&page[cursor]=string&page[size]=100&sort=createdGet all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending… - GETGet Category IDs for Catalog Item
/api/catalog-items/:id/relationships/categories?filter=any(ids,['$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL'])&page[cursor]=string&page[size]=100&sort=createdGet all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady:… - POSTAdd Categories to Catalog Item
/api/catalog-items/:id/relationships/categoriesCreate a new catalog category relationship for the given item ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: catalogs:write OpenAPI Spec - DELETERemove Categories from Catalog Item
/api/catalog-items/:id/relationships/categoriesDelete catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: catalogs:write OpenAPI Spec - PATCHUpdate Categories for Catalog Item
/api/catalog-items/:id/relationships/categoriesUpdate catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: catalogs:write OpenAPI Spec
Conversations
- POSTCreate Conversation Message
/api/conversation-messagesSend an outbound message to a conversation. Requires account-level enablement. To request access, reach out in the developer community.<br><br>*Rate…
Coupons
- GETGet Coupons
/api/coupons?fields[coupon]=assigner_configuration&page[cursor]=string&page[size]=100Get all coupons in an account. To learn more, see our Coupons API guide.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: coupons:read OpenAPI Spec - POSTCreate Coupon
/api/coupons?fields[coupon]=assigner_configurationCreates a new coupon.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: coupons:write OpenAPI Spec - GETGet Coupon
/api/coupons/:id?fields[coupon]=assigner_configurationGet a specific coupon with the given coupon ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: coupons:read OpenAPI Spec - DELETEDelete Coupon
/api/coupons/:idDelete the coupon with the given coupon ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: coupons:write OpenAPI Spec - PATCHUpdate Coupon
/api/coupons/:id?fields[coupon]=assigner_configuration*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: coupons:write OpenAPI Spec - GETGet Coupon Codes
/api/coupon-codes?fields[coupon-code]=expires_at&fields[coupon]=assigner_configuration&filter=equals(coupon.id,'10OFF')&include=coupon&page[cursor]=string&page[size]=100Gets a list of coupon codes associated with a coupon/coupons or a profile/profiles. A coupon/coupons or a profile/profiles must be provided as required filter… - POSTCreate Coupon Code
/api/coupon-codes?fields[coupon-code]=expires_atSynchronously creates a coupon code for the given coupon.<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady: 3500/m Scopes: coupon-codes:write OpenAPI Spec - GETGet Coupon Code
/api/coupon-codes/:id?fields[coupon-code]=expires_at&fields[coupon]=assigner_configuration&include=couponReturns a Coupon Code specified by the given identifier.<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady: 3500/m Scopes: coupon-codes:read OpenAPI Spec - DELETEDelete Coupon Code
/api/coupon-codes/:idDeletes a coupon code specified by the given identifier synchronously. If a profile has been assigned to the coupon code, an exception will be… - PATCHUpdate Coupon Code
/api/coupon-codes/:id?fields[coupon-code]=expires_atUpdates a coupon code specified by the given identifier synchronously. We allow updating the 'status' and 'expires_at' of coupon codes.<br><br>*Rate… - GETGet Bulk Create Coupon Code Jobs
/api/coupon-code-bulk-create-jobs?fields[coupon-code-bulk-create-job]=completed_at&filter=equals(status,'processing')&page[cursor]=stringGet all coupon code bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes:… - POSTBulk Create Coupon Codes
/api/coupon-code-bulk-create-jobs?fields[coupon-code-bulk-create-job]=completed_atCreate a coupon-code-bulk-create-job to bulk create a list of coupon codes. Max number of coupon codes per job we allow for is 1000. Max number of jobs queued… - GETGet Bulk Create Coupon Codes Job
/api/coupon-code-bulk-create-jobs/:job_id?fields[coupon-code-bulk-create-job]=completed_at&fields[coupon-code]=expires_at&include=coupon-codesGet a coupon code bulk create job with the given job ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: coupon-codes:read OpenAPI Spec - GETGet Coupon For Coupon Code
/api/coupon-codes/:id/coupon?fields[coupon]=assigner_configurationGet the coupon associated with a given coupon code ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: coupons:read OpenAPI Spec - GETGet Coupon ID for Coupon Code
/api/coupon-codes/:id/relationships/couponGets the coupon relationship associated with the given coupon code id<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: coupons:read OpenAPI Spec - GETGet Coupon Codes for Coupon
/api/coupons/:id/coupon-codes?fields[coupon-code]=expires_at&filter=less-than(expires_at,2022-11-08T00:00:00+00:00)&page[cursor]=string&page[size]=100Gets a list of coupon codes associated with the given coupon id<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: coupon-codes:read OpenAPI Spec - GETGet Coupon Code IDs for Coupon
/api/coupons/:id/relationships/coupon-codes?filter=less-than(expires_at,2022-11-08T00:00:00+00:00)&page[cursor]=string&page[size]=100Gets a list of coupon code relationships associated with the given coupon id<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: coupon-codes:read…
Custom Objects
- GETGet Data Sources
/api/data-sources?fields[data-source]=description&filter=equals(namespace,'custom-objects')&page[cursor]=string&page[size]=20Get all data sources in an account.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - POSTCreate Data Source
/api/data-sources?fields[data-source]=descriptionCreate a new data source in an account<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec - GETGet Data Source
/api/data-sources/:id?fields[data-source]=descriptionRetrieve a data source in an account.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - DELETEDelete Data Source
/api/data-sources/:idDelete a data source in an account.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec - GETGet Source Mapping
/api/source-mappings/:id?fields[source-mapping]=idGet the source mapping with the given ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - PATCHUpdate Source Mapping
/api/source-mappings/:id?fields[source-mapping]=idUpdate the source mapping with the given ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec - GETGet Object Types
/api/object-types?fields[object-schema]=description&fields[object-type]=created_at&filter=equals(namespace,'custom-objects')&include=current-schemaGet all object types in an account.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - POSTCreate Object Type
/api/object-types?fields[object-type]=created_atCreate an object type.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec - GETGet Object Type
/api/object-types/:id?fields[object-schema]=description&fields[object-type]=created_at&fields[profile-object-type]=id&include=current-schemaGet the object type with the given ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - DELETEDelete Object Type
/api/object-types/:idDelete the object type with the given ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec - GETGet Object Schema
/api/object-schemas/:id?fields[object-schema]=description&fields[profile-object-schema]=id&fields[source-mapping]=id&include=object-schemasGet the object schema with the given ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - PATCHUpdate Object Schema
/api/object-schemas/:id?fields[object-schema]=descriptionUpdate the object schema with the given ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec - GETGet Object Record
/api/object-records/:id?fields[object-record]=idGet the object record with the given compound ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - POSTBulk Create Data Source Records
/api/data-source-record-bulk-create-jobsCreate a bulk data source record import job to create a batch of records. Accepts up to 500 records per request. The maximum allowed payload size is 4MB. The… - POSTCreate Data Source Record
/api/data-source-record-create-jobsCreate a data source record import job to create a single record. The maximum allowed payload size per-record is 512KB. To learn more, see our Custom Objects… - POSTCreate Object Schema
/api/object-schemas?fields[object-schema]=descriptionCreate an object schema.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec - POSTBulk Delete Object Records
/api/object-record-bulk-delete-jobsDelete a batch of object records. Accepts up to 500 object record IDs per request. The maximum allowed payload size is 5MB.<br><br>*Rate limits*:<br>Burst:… - GETGet Records for Object Type
/api/object-types/:id/object-records?fields[object-record]=id&page[cursor]=string&page[size]=20Get all object records for a given object type.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - GETGet Record IDs for Object Type
/api/object-types/:id/relationships/object-records?page[cursor]=string&page[size]=20Get all object records for a given object type.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - GETGet Ingestion Logs for Object Type
/api/object-types/:id/object-ingestion-logs?fields[object-ingestion-log]=errors&fields[object-record]=id&fields[object-type]=created_at&filter=equals(record_id,'A3LD92')&include=object-record&page[cursor]=stringGet the ingestion logs for a given object type. Only ingestion failures are logged — the absence of a log entry for a record does not mean the record was… - GETGet Ingestion Log IDs for Object Type
/api/object-types/:id/relationships/object-ingestion-logs?filter=equals(record_id,'A3LD92')&page[cursor]=stringGet the ingestion logs for a given object type. Only ingestion failures are logged — the absence of a log entry for a record does not mean the record was… - GETGet Current Schema for Object Type
/api/object-types/:id/current-schema?fields[object-schema]=descriptionGet current schema for an object type<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - GETGet Current Schema ID for Object Type
/api/object-types/:id/relationships/current-schemaGet current schema for an object type<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - GETGet Draft Schema for Object Type
/api/object-types/:id/draft-schema?fields[object-schema]=descriptionGet draft schema for an object type<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - GETGet Draft Schema ID for Object Type
/api/object-types/:id/relationships/draft-schemaGet draft schema for an object type<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - GETGet Schema Versions for Object Type
/api/object-types/:id/schema-versions?fields[object-schema]=descriptionGet all schema versions for an object type<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - GETGet Schema Version IDs for Object Type
/api/object-types/:id/relationships/schema-versionsGet all schema versions for an object type<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - GETGet Object Type Relationships
/api/object-types/:id/relationships/object-typesGet related object types for an object type<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - GETGet Profile Type Relationships
/api/object-types/:id/relationships/profile-object-typesGet related profile object types for an object type<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - GETGet Source Mapping for Object Schema
/api/object-schemas/:id/source-mapping?fields[source-mapping]=idGet source mapping for an object schema<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - GETGet Source Mapping ID for Object Schema
/api/object-schemas/:id/relationships/source-mappingGet source mapping for an object schema<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - GETGet Object Schema Relationships
/api/object-schemas/:id/relationships/object-schemasGet related object schemas for an object schema<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - POSTCreate Object Schema Relationship
/api/object-schemas/:id/relationships/object-schemasCreate a relationship between object schemas. Note that flow filtering and segmentation are currently not supported for object-to-object… - DELETEDelete Object Schema Relationship
/api/object-schemas/:id/relationships/object-schemasDelete a relationship between object schemas<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec - PATCHUpdate Object Schema Relationship
/api/object-schemas/:id/relationships/object-schemasUpdate a relationship between object schemas<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec - GETGet Profile Schema Relationships
/api/object-schemas/:id/relationships/profile-object-schemasGet related profile object schemas for an object schema<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec - POSTCreate Profile Schema Relationship
/api/object-schemas/:id/relationships/profile-object-schemasCreate a relationship between an object schema and a profile<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec - DELETEDelete Profile Schema Relationship
/api/object-schemas/:id/relationships/profile-object-schemasDelete a relationship between an object schema and a profile<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec - PATCHUpdate Profile Schema Relationship
/api/object-schemas/:id/relationships/profile-object-schemasUpdate a relationship between an object schema and a profile<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec
Data Privacy
- POSTRequest Profile Deletion
/api/data-privacy-deletion-jobsRequest a deletion for the profiles corresponding to one of the following identifiers: email, phone_number, or id. If multiple identifiers are provided, we…
Events
- GETGet Events
/api/events?fields[attribution]=id&fields[event]=datetime&fields[metric]=created&fields[profile]=created&filter=equals(metric_id,'example')&include=attributions&page[cursor]=string&page[size]=200&sort=datetimeGet all events in an account Requests can be sorted by the following fields: datetime, timestamp Custom metrics are not supported in the metric_id filter.… - POSTCreate Event
/api/eventsCreate a new event to track a profile's activity. Note that this endpoint allows you to create a new profile or update an existing profile's properties. At a… - GETGet Event
/api/events/:id?fields[attribution]=id&fields[event]=datetime&fields[metric]=created&fields[profile]=created&include=attributionsGet an event with the given event ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: events:read OpenAPI Spec - POSTBulk Create Events
/api/event-bulk-create-jobsCreate a batch of events for one or more profiles. Note that this endpoint allows you to create new profiles or update existing profile properties. At a… - GETGet Metric for Event
/api/events/:id/metric?fields[metric]=createdGet the metric for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady: 3500/m Scopes: events:read metrics:read OpenAPI Spec - GETGet Metric ID for Event
/api/events/:id/relationships/metricGet a list of related Metrics for an Event<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady: 3500/m Scopes: events:read metrics:read OpenAPI Spec - GETGet Profile for Event
/api/events/:id/profile?additional-fields[profile]=subscriptions&fields[profile]=createdGet the profile associated with an event with the given event ID.<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady: 3500/m Scopes: events:read profiles:read… - GETGet Profile ID for Event
/api/events/:id/relationships/profileGet profile relationships for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: 350/s<br>Steady: 3500/m Scopes: events:read profiles:read…
Flows
- GETGet Flows
/api/flows?fields[flow-action]=created&fields[flow]=archived&fields[tag]=id&filter=any(id,['example'])&include=flow-actions&page[cursor]=string&page[size]=50&sort=createdGet all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst:… - POSTCreate Flow
/api/flows?additional-fields[flow]=definition&fields[flow]=archivedCreate a new flow using an encoded flow definition. New objects within the flow definition, such as actions, will need to use a temporary_id field for… - GETGet Flow
/api/flows/:id?additional-fields[flow]=definition&fields[flow-action]=created&fields[flow]=archived&fields[tag]=id&include=flow-actionsGet a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: flows:read OpenAPI Spec - DELETEDelete Flow
/api/flows/:idDelete a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: flows:write OpenAPI Spec - PATCHUpdate Flow Status
/api/flows/:id?fields[flow]=archivedUpdate the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: flows:write… - GETGet Flow Action
/api/flow-actions/:id?fields[flow-action]=created&fields[flow-message]=channel&fields[flow]=archived&include=flowGet a flow action from a flow with the given flow action ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: flows:read OpenAPI Spec - DELETEDelete Flow Action
/api/flow-actions/:idDelete a flow action.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: flows:write OpenAPI Spec - PATCHUpdate Flow Action
/api/flow-actions/:id?fields[flow-action]=createdUpdate a flow action.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: flows:write OpenAPI Spec - GETGet Flow Message
/api/flow-messages/:id?fields[flow-action]=created&fields[flow-message]=channel&fields[template]=amp&include=flow-actionGet a flow message from a flow with the given flow message ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: flows:read OpenAPI Spec - POSTCreate Flow Action
/api/flow-actions?fields[flow-action]=createdInsert a new action into an existing flow. Choose exactly one placement mechanism: Use anchor-action to insert after an existing action on one of its outgoing… - GETGet Actions for Flow
/api/flows/:id/flow-actions?fields[flow-action]=created&filter=any(id,['example'])&page[cursor]=string&page[size]=50&sort=action_typeGet all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based… - GETGet Action IDs for Flow
/api/flows/:id/relationships/flow-actions?filter=any(id,['example'])&page[cursor]=string&page[size]=50&sort=action_typeGet all relationships for flow actions associated with the given flow ID. Returns a maximum of 100 flows per request, which can be paginated with cursor-based… - GETGet Tags for Flow
/api/flows/:id/tags?fields[tag]=idReturn all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: flows:read tags:read OpenAPI Spec - GETGet Tag IDs for Flow
/api/flows/:id/relationships/tagsReturn the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: flows:read tags:read OpenAPI Spec - GETGet Flow for Flow Action
/api/flow-actions/:id/flow?fields[flow]=archivedGet the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: flows:read OpenAPI Spec - GETGet Flow ID for Flow Action
/api/flow-actions/:id/relationships/flowGet the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: flows:read OpenAPI Spec - GETGet Messages For Flow Action
/api/flow-actions/:id/flow-messages?fields[flow-message]=channel&filter=any(id,['example'])&page[cursor]=string&page[size]=50&sort=createdGet all flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with… - GETGet Message IDs for Flow Action
/api/flow-actions/:id/relationships/flow-messages?filter=equals(name,'example')&page[cursor]=string&page[size]=50&sort=createdGet all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be… - GETGet Action for Flow Message
/api/flow-messages/:id/flow-action?fields[flow-action]=createdGet the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: flows:read OpenAPI Spec - GETGet Action ID for Flow Message
/api/flow-messages/:id/relationships/flow-actionGet the relationship for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: flows:read OpenAPI Spec - GETGet Template for Flow Message
/api/flow-messages/:id/template?fields[template]=ampReturn the related template<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: templates:read OpenAPI Spec - GETGet Template ID for Flow Message
/api/flow-messages/:id/relationships/templateReturns the ID of the related template<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: templates:read OpenAPI Spec
Forms
- GETGet Forms
/api/forms?fields[form]=ab_test&filter=equals(id,'Y6nRLr')&page[cursor]=string&page[size]=20&sort=created_atGet all forms in an account.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: forms:read OpenAPI Spec - POSTCreate Form
/api/forms?fields[form]=ab_testCreate a new form.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: forms:write OpenAPI Spec - GETGet Form
/api/forms/:id?fields[form]=ab_testGet the form with the given ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: forms:read OpenAPI Spec - DELETEDelete Form
/api/forms/:idDelete a given form.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: forms:write OpenAPI Spec - PATCHUpdate Form
/api/forms/:id?fields[form]=ab_testUpdate a form. Only submitted attributes change, and definition replaces the stored definition. Live versions and form lifecycle fields cannot be… - GETGet Form Version
/api/form-versions/:id?fields[form-version]=ab_test&fields[form]=ab_test&include=formGet the form version with the given ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: forms:read OpenAPI Spec - POSTPublish Form
/api/form-publish-jobs?fields[form-publish-job]=created_atPublish the draft version of a form. The publish completes synchronously; the returned job resource cannot be retrieved afterwards. Forms with a draft A/B… - POSTUnpublish Form
/api/form-unpublish-jobs?fields[form-unpublish-job]=created_atUnpublish the live version of a form. The unpublish completes synchronously; the returned job resource cannot be retrieved afterwards. Forms with a live A/B… - GETGet Versions for Form
/api/forms/:id/form-versions?fields[form-version]=ab_test&filter=equals(form_type,'popup')&page[cursor]=string&page[size]=20&sort=created_atGet the form versions for the given form.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: forms:read OpenAPI Spec - GETGet Version IDs for Form
/api/forms/:id/relationships/form-versions?filter=equals(form_type,'popup')&page[cursor]=string&page[size]=20&sort=created_atGet the IDs of the form versions for the given form.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: forms:read OpenAPI Spec - GETGet Form for Form Version
/api/form-versions/:id/form?fields[form]=ab_testGet the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: forms:read OpenAPI Spec - GETGet Form ID for Form Version
/api/form-versions/:id/relationships/formGet the ID of the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: forms:read OpenAPI Spec
Images
- GETGet Images
/api/images?fields[image]=format&filter=equals(id,'7')&page[cursor]=string&page[size]=20&sort=formatGet all images in an account.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: images:read OpenAPI Spec - POSTUpload Image From URL
/api/images?fields[image]=formatImport an image from a url or data uri. If you want to upload an image from a file, use the Upload Image From File endpoint instead.<br><br>*Rate… - GETGet Image
/api/images/:id?fields[image]=formatGet the image with the given image ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: images:read OpenAPI Spec - PATCHUpdate Image
/api/images/:id?fields[image]=formatUpdate the image with the given image ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: images:write OpenAPI Spec - POSTUpload Image From File
/api/image-upload?fields[image]=formatUpload an image from a file. If you want to import an image from an existing url or a data uri, use the Upload Image From URL endpoint instead.<br><br>*Rate…
Lists
- GETGet Lists
/api/lists?fields[flow]=archived&fields[list]=created&fields[tag]=id&filter=equals(name,['example'])&include=flow-triggers&page[cursor]=string&page[size]=10&sort=createdGet all lists in an account. Filter to request a subset of all lists. Lists can be filtered by id, name, created, and updated fields. Returns a maximum of 10… - POSTCreate List
/api/lists?fields[list]=createdCreate a new list.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m<br>Daily: 150/d Scopes: lists:write OpenAPI Spec - GETGet List
/api/lists/:id?additional-fields[list]=profile_count&fields[flow]=archived&fields[list]=created&fields[tag]=id&include=flow-triggersGet a list with the given list ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m<br><br>Rate limits when using the… - DELETEDelete List
/api/lists/:idDelete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: lists:write OpenAPI Spec - PATCHUpdate List
/api/lists/:id?fields[list]=createdUpdate the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: lists:write OpenAPI Spec - GETGet Tags for List
/api/lists/:id/tags?fields[tag]=idReturn all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: lists:read tags:read OpenAPI Spec - GETGet Tag IDs for List
/api/lists/:id/relationships/tagsReturn all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: lists:read tags:read OpenAPI Spec - GETGet Profiles for List
/api/lists/:id/profiles?additional-fields[profile]=subscriptions&fields[profile]=created&filter=equals(email,['example'])&page[cursor]=string&page[size]=20&sort=joined_group_atGet all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by email, phone_number,… - GETGet Profile IDs for List
/api/lists/:id/relationships/profiles?filter=equals(email,['example'])&page[cursor]=string&page[size]=20&sort=joined_group_atGet profile membership relationships for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m<br><br>Rate limits when using… - POSTAdd Profiles to List
/api/lists/:id/relationships/profilesAdd a profile to a list with the given list ID. It is recommended that you use the Subscribe Profiles endpoint if you're trying to give a profile consent to… - DELETERemove Profiles from List
/api/lists/:id/relationships/profilesRemove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a… - GETGet Flows Triggered by List
/api/lists/:id/flow-triggers?fields[flow]=archivedGet all flows where the given list ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: flows:read lists:read OpenAPI… - GETGet IDs for Flows Triggered by List
/api/lists/:id/relationships/flow-triggersGet the IDs of all flows where the given list is being used as the trigger.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: flows:read lists:read…
Metrics
- GETGet Metrics
/api/metrics?fields[flow]=archived&fields[metric]=created&filter=equals(integration.name,'example')&include=flow-triggers&page[cursor]=stringGet all metrics in an account. Requests can be filtered by the following fields: integration name, integration category Returns a maximum of 200 results per… - GETGet Metric
/api/metrics/:id?fields[flow]=archived&fields[metric]=created&include=flow-triggersGet a metric with the given metric ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: metrics:read OpenAPI Spec - GETGet Metric Property
/api/metric-properties/:id?additional-fields[metric-property]=sample_values&fields[metric-property]=id&fields[metric]=created&include=metricGet a metric property with the given metric property ID.<br><br>*Rate limits*:<br>Burst: 1/s<br>Steady: 15/m Scopes: metrics:read OpenAPI Spec - GETGet Custom Metrics
/api/custom-metrics?fields[custom-metric]=created&fields[metric]=created&include=metricsGet all custom metrics in an account.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: metrics:read OpenAPI Spec - POSTCreate Custom Metric
/api/custom-metrics?fields[custom-metric]=createdCreate a new custom metric. Custom metric objects must include a name and definition.<br><br>*Rate limits*:<br>Burst: 1/s<br>Steady: 15/m<br>Daily: 15/d… - GETGet Custom Metric
/api/custom-metrics/:id?fields[custom-metric]=created&fields[metric]=created&include=metricsGet a custom metric with the given custom metric ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: metrics:read OpenAPI Spec - DELETEDelete Custom Metric
/api/custom-metrics/:idDelete a custom metric with the given custom metric ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: metrics:write OpenAPI Spec - PATCHUpdate Custom Metric
/api/custom-metrics/:id?fields[custom-metric]=createdUpdate a custom metric with the given custom metric ID.<br><br>*Rate limits*:<br>Burst: 1/s<br>Steady: 15/m<br>Daily: 15/d Scopes: metrics:write OpenAPI Spec - GETGet Mapped Metrics
/api/mapped-metrics?fields[custom-metric]=created&fields[mapped-metric]=id&fields[metric]=created&include=custom-metricGet all mapped metrics in an account.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: metrics:read OpenAPI Spec - GETGet Mapped Metric
/api/mapped-metrics/:id?fields[custom-metric]=created&fields[mapped-metric]=id&fields[metric]=created&include=custom-metricGet the mapped metric with the given ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: metrics:read OpenAPI Spec - PATCHUpdate Mapped Metric
/api/mapped-metrics/:id?fields[mapped-metric]=idUpdate the mapped metric with the given ID.<br><br>*Rate limits*:<br>Burst: 1/s<br>Steady: 15/m<br>Daily: 30/d Scopes: metrics:write OpenAPI Spec - POSTQuery Metric Aggregates
/api/metric-aggregates?fields[metric-aggregate]=dataQuery and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events (not to be confused… - GETGet Flows Triggered by Metric
/api/metrics/:id/flow-triggers?fields[flow]=archivedGet all flows where the given metric is being used as the trigger.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: flows:read metrics:read… - GETGet IDs for Flows Triggered by Metric
/api/metrics/:id/relationships/flow-triggersGet the IDs of all flows where the given metric is being used as the trigger.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: flows:read… - GETGet Properties for Metric
/api/metrics/:id/metric-properties?additional-fields[metric-property]=sample_values&fields[metric-property]=idGet the metric properties for the given metric ID.<br><br>*Rate limits*:<br>Burst: 1/s<br>Steady: 15/m Scopes: metrics:read OpenAPI Spec - GETGet Property IDs for Metric
/api/metrics/:id/relationships/metric-propertiesGet the IDs of metric properties for the given metric.<br><br>*Rate limits*:<br>Burst: 1/s<br>Steady: 15/m Scopes: metrics:read OpenAPI Spec - GETGet Metric for Metric Property
/api/metric-properties/:id/metric?fields[metric]=createdGet the metric for the given metric property ID.<br><br>*Rate limits*:<br>Burst: 1/s<br>Steady: 15/m Scopes: metrics:read OpenAPI Spec - GETGet Metric ID for Metric Property
/api/metric-properties/:id/relationships/metricGet the ID of the metric for the given metric property.<br><br>*Rate limits*:<br>Burst: 1/s<br>Steady: 15/m Scopes: metrics:read OpenAPI Spec - GETGet Metrics for Custom Metric
/api/custom-metrics/:id/metrics?fields[metric]=createdGet all metrics for the given custom metric ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: metrics:read OpenAPI Spec - GETGet Metric IDs for Custom Metric
/api/custom-metrics/:id/relationships/metricsGet all metrics for the given custom metric ID.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: metrics:read OpenAPI Spec - GETGet Metric for Mapped Metric
/api/mapped-metrics/:id/metric?fields[metric]=createdGet the metric for the given mapped metric ID (if applicable).<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: metrics:read OpenAPI Spec - GETGet Metric ID for Mapped Metric
/api/mapped-metrics/:id/relationships/metricGet the ID of the metric for the given mapped metric.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: metrics:read OpenAPI Spec - GETGet Custom Metric for Mapped Metric
/api/mapped-metrics/:id/custom-metric?fields[custom-metric]=createdGet the custom metric for the given mapped metric ID (if applicable).<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: metrics:read OpenAPI Spec - GETGet Custom Metric ID for Mapped Metric
/api/mapped-metrics/:id/relationships/custom-metricGet the ID of the custom metric for the given mapped metric.<br><br>*Rate limits*:<br>Burst: 3/s<br>Steady: 60/m Scopes: metrics:read OpenAPI Spec
Profiles
- GETGet Profiles
/api/profiles?additional-fields[profile]=subscriptions&fields[conversation]=channel&fields[profile]=created&fields[push-token]=background&filter=equals(id,'example')&include=conversations&page[cursor]=string&page[size]=20&sort=createdGet all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: id, created, updated, email,… - POSTCreate Profile
/api/profiles?additional-fields[profile]=subscriptions&fields[profile]=createdCreate a new profile. Use the additional-fields parameter to include subscriptions and predictive analytics data in your response. The maximum allowed payload… - GETGet Profile
/api/profiles/:id?additional-fields[profile]=subscriptions&fields[conversation]=channel&fields[list]=created&fields[profile]=created&fields[push-token]=background&fields[segment]=created&include=conversationsGet the profile with the given profile ID. Use the additional-fields parameter to include subscriptions and predictive analytics data in your… - PATCHUpdate Profile
/api/profiles/:id?additional-fields[profile]=subscriptions&fields[profile]=createdUpdate the profile with the given profile ID. Use the additional-fields parameter to include subscriptions and predictive analytics data in your response.… - GETGet Bulk Import Profiles Jobs
/api/profile-bulk-import-jobs?fields[profile-bulk-import-job]=completed_at&filter=equals(status,'queued')&page[cursor]=string&page[size]=20&sort=created_atGet all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: lists:read… - POSTBulk Import Profiles
/api/profile-bulk-import-jobs?fields[profile-bulk-import-job]=completed_atCreate a bulk profile import job to create or update a batch of profiles. Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB.… - GETGet Bulk Import Profiles Job
/api/profile-bulk-import-jobs/:job_id?fields[list]=created&fields[profile-bulk-import-job]=completed_at&include=listsGet a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: lists:read profiles:read OpenAPI Spec - GETGet Bulk Suppress Profiles Jobs
/api/profile-suppression-bulk-create-jobs?fields[profile-suppression-bulk-create-job]=completed_at&filter=equals(status,'processing')&page[cursor]=string&sort=createdGet the status of all bulk profile suppression jobs.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: subscriptions:read OpenAPI Spec - POSTBulk Suppress Profiles
/api/profile-suppression-bulk-create-jobs?fields[profile-suppression-bulk-create-job]=completed_atManually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list. Suppressed profiles cannot receive… - GETGet Bulk Suppress Profiles Job
/api/profile-suppression-bulk-create-jobs/:job_id?fields[profile-suppression-bulk-create-job]=completed_atGet the bulk suppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: subscriptions:read OpenAPI Spec - GETGet Bulk Unsuppress Profiles Jobs
/api/profile-suppression-bulk-delete-jobs?fields[profile-suppression-bulk-delete-job]=completed_at&filter=equals(status,'processing')&page[cursor]=string&sort=createdGet all bulk unsuppress profiles jobs.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: subscriptions:read OpenAPI Spec - POSTBulk Unsuppress Profiles
/api/profile-suppression-bulk-delete-jobs?fields[profile-suppression-bulk-delete-job]=completed_atManually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a segment/list. This only removes suppressions… - GETGet Bulk Unsuppress Profiles Job
/api/profile-suppression-bulk-delete-jobs/:job_id?fields[profile-suppression-bulk-delete-job]=completed_atGet the bulk unsuppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: 75/s<br>Steady: 750/m Scopes: subscriptions:read OpenAPI Spec - GETGet Push Tokens
/api/push-tokens?fields[profile]=created&fields[push-token]=background&filter=equals(id,'example')&include=profile&page[cursor]=string&page[size]=20Return push tokens associated with company.<br><br>*Rate limits*:<br>Burst: 10/s<br>Steady: 150/m Scopes: profiles:read push-tokens:read OpenAPI Spec - POSTCreate or Update Push Token
/api/push-tokensCreate or update a push token. This endpoint can be used to migrate push tokens from another platform to Klaviyo. Please use our mobile SDKs (iOS and Android)…
Showing 300 of 400 endpoints. Fork the collection to see all of them.
API details
- Base URL
https://a.klaviyo.com- Authentication
- An API key in the Authorization header
- Operations
- 436 operations on 303 pathsGET 256POST 100PATCH 42DELETE 38
- Main resources
- Campaigns 59Catalogs 55Custom Objects 39Profiles 38Tags 26Brands 25Metrics 24Flows 22Coupons 17Templates 17
- Response formats
application/vnd.api+json- Description format
- OpenAPI 3.0.2, API version
2026-10-15 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Klaviyo's published OpenAPI description (klaviyo/openapi) (MIT)
How to test the Klaviyo API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Klaviyo API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get Accounts” (GET /api/accounts?fields[account]=contact_information), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Klaviyo API?
The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. It is listed under Communication and has 436 endpoints.
Who publishes the Klaviyo API?
It is listed from Klaviyo's public API description (an OpenAPI document), not published by Klaviyo on Swastik Codes. Anyone who controls klaviyo.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Klaviyo API?
Requests go to https://a.klaviyo.com. Endpoint paths are added to this base URL.
How do I authenticate with the Klaviyo API?
With an API key in the Authorization header.
How many endpoints does the Klaviyo API have?
436 operations on 303 paths (256 GET, 100 POST, 42 PATCH, 38 DELETE). The largest groups are Campaigns, Catalogs, Custom Objects, Profiles. This listing's collection holds the first 400.
Is forking the Klaviyo API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.