v36

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-017439390.7 KB

Get Customer Automation Campaigns

This API retrieves the available automation campaigns for the customer, identified by customerId. The response includes details of campaigns currently active and applicable to the customer, such as onboarding journeys, engagement triggers, or milestone-based campaigns. Specific campaign types can be filtered, including campaigns like Welcome Campaigns, Ramadan Campaign, and Custom Automations, offering a comprehensive view of personalized campaigns available for the customer.

get/api/v4.0/integrations/customers/{customerId}/automation

Path parameters

customerIdstring required

Unique identifier for the customer that you can reference across the customer's whole lifetime. Could be a database ID, random string, email, or anything that uniquely identifies the customer.

Query parameters

campaignType'mission' | 'all'

Filters automation steps by a specific type, such as: mission (return steps for mission-based campaigns, default), all (return all automation steps and details).

Response

Customer automation campaigns found

countnumber

The total number of automation campaigns available