Skip to main content
GET
/
api
/
v4.0
/
integrations
/
customers
/
{customerId}
/
automation
Get Customer Automation Campaigns
curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/customers/{customerId}/automation \
  --header 'apikey: <api-key>'
{
  "campaigns": [
    {
      "automation": [
        {
          "order": 123,
          "name": "<string>",
          "isUnlocked": true,
          "completed": true,
          "steps": [
            {
              "type": "<string>",
              "order": 123,
              "completed": true,
              "configuration": {}
            }
          ],
          "completionPercentage": 123
        }
      ],
      "automationCount": 123
    }
  ],
  "count": 123
}
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.
Security: Requires apikey header.

Authorizations

​
apikey
string
header
required

Path Parameters

​
customerId
string
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
enum<string>
default:mission

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

Available options:
mission,
all

Response

200 - application/json

Customer automation campaigns found

​
campaigns
object[]

A list of campaigns containing automation workflows

​
count
number

The total number of automation campaigns available