INinstantly
CampaignSubsequence

List campaign subsequence

Changed on

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

get/api/v2/subsequences

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/subsequences
  • Auth
    HTTP bearer

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
Example:123e4567-e89b-12d3-a456-426614174000

The ID of the campaign to list the subsequences of.

parent_campaign_notstring uuid
Example:123e4567-e89b-12d3-a456-426614174000

The ID of a campaign to exclude subsequences of, returning reusable subsequences from the workspace's other campaigns instead.

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": "01a19e6f-3f88-70fe-babf-1603293fe687",
      "timestamp_created": "2026-11-02T22:44:13.320Z",
      "parent_campaign": "01a19e6f-3f88-70fe-babf-160468a75fbc",
      "workspace": "01a19e6f-3f88-70fe-babf-1605ac481d0a",
      "timestamp_leads_updated": "2026-11-02T22:44:13.320Z",
      "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}},<br/><br/>I hope you are doing well.",
                  "v_disabled": true
                }
              ]
            }
          ]
        }
      ],
      "auto_variant_select": {
        "trigger": "click_rate"
      },
      "daily_limit_mode": "inherit",
      "daily_limit": 50
    }
  ],
  "next_starting_after": "01a19e6f-898d-74d8-9d43-acdec5bc20ce"
}

Changes

  • c781051105a8Revision changes
    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • info

      added the new optional query request parameter parent_campaign_not

    • info

      the query request parameter parent_campaign became optional

    • info

      added the optional property // to the response with the status

    • info

      added 'contains' constraint to the ////// response property for the status

    • info

      removed the -1.00 enum value from the //// response property for the response status

    • info

      removed the -2.00 enum value from the //// response property for the response status

    • info

      removed the -3.00 enum value from the //// response property for the response status

    • info

      removed the -4.00 enum value from the //// response property for the response status

    • info

      removed the 0.00 enum value from the //// response property for the response status

    • info

      removed the 1.00 enum value from the //// response property for the response status

    • info

      removed the 2.00 enum value from the //// response property for the response status

    • info

      removed the 3.00 enum value from the //// response property for the response status

    • info

      removed the 4.00 enum value from the //// response property for the response status