---
title: "Get Customer Automation Campaigns"
method: GET
path: "/api/v4.0/integrations/customers/{customerId}/automation"
---

# Get Customer Automation Campaigns

`GET /api/v4.0/integrations/customers/{customerId}/automation`

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.

## Path parameters

- `customerId` string, required

## Query parameters

- `campaignType` 'mission' | 'all'

## Response `200`

Customer automation campaigns found

- CustomerAutomationCampaignsResponse
  - `campaigns` object[] — A list of campaigns containing automation workflows
    - `automation` object[] — A list of automation workflows within a campaign
      - `order` number — The order in which this automation appears
      - `name` string — The internal name of the automation workflow
      - `isUnlocked` boolean — Whether this automation is unlocked
      - `completed` boolean — Whether the automation has been fully completed
      - `steps` object[], nullable — List of steps involved in completing the automation.
        - `type` string — The type of step, for example rewarding a badge or adding points.
        - `order` number — The order of this step within the automation sequence.
        - `completed` boolean — Whether this step has been completed or not.
        - `configuration` object, nullable — Configuration details for the step, such as badge name & icon.
      - `completionPercentage` number — Percentage of completion for the automation
    - `automationCount` number — Total number of automations available within this campaign
  - `count` number — The total number of automation campaigns available

---

[API](https://skmtc.net/gameballers/apis/gameball-api.md) · [All operations](https://skmtc.net/gameballers/apis/gameball-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gameballers/gameball-api/revisions/2e4a8bfe2291/schema)