Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
CampaignSubsequence

List campaign subsequence

Requires one of the following scopes: subsequences:read, subsequences:all, all:read, all:all

get/api/v2/subsequences

Query parameters

limitinteger
Example:10

The number of items to return

starting_afterstring
Example:01956fbd-0eb1-72db-a565-82977a586084

The ID of the last item in the previous page - used for pagination. You can use the value of the next_starting_after field from the previous response.

parent_campaignstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

The ID of the campaign to list the subsequences of.

searchstring
Example:test

The search query to filter the subsequences by.

Response

The list of Campaign Subsequence

next_starting_afterstring

The filter for getting the next items after this one, this could either be a UUID, a timestamp, on an email depending on the specific API

Example response

{
  "items": [
    {
      "id": "019f94cd-8401-74c3-98cb-8d4953fe76bd",
      "timestamp_created": "2026-07-24T15:45:24.481Z",
      "parent_campaign": "019f94cd-8401-74c3-98cb-8d4a3ce0a67b",
      "workspace": "019f94cd-8401-74c3-98cb-8d4b8582121a",
      "timestamp_leads_updated": "2026-07-24T15:45:24.481Z",
      "name": "Follow-up sequence",
      "conditions": {
        "crm_status": [
          1
        ],
        "lead_activity": [
          4
        ],
        "reply_contains": "yes"
      },
      "subsequence_schedule": {
        "start_date": "2025-09-25",
        "end_date": "2025-09-25",
        "schedules": [
          {
            "name": "My Schedule",
            "timing": {
              "from": "09:00",
              "to": "17:00"
            },
            "days": {
              "0": true,
              "1": true,
              "2": true,
              "3": true,
              "4": true
            },
            "timezone": "Etc/GMT+12"
          }
        ]
      },
      "sequences": [
        {
          "steps": [
            {
              "type": "email",
              "delay": 2,
              "delay_unit": "days",
              "pre_delay": 2,
              "pre_delay_unit": "days",
              "variants": [
                {
                  "subject": "Hello {{firstName}}",
                  "body": "Hey {{firstName}},\n\nI hope you are doing well.",
                  "v_disabled": true
                }
              ]
            }
          ]
        }
      ],
      "daily_limit_mode": "inherit",
      "daily_limit": 50
    }
  ],
  "next_starting_after": "019f94cd-af2d-786c-a68d-ab99329e2c83"
}