v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB

Campaign

List campaign

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

get/api/v2/campaigns

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.

searchstring

Example:Summer Sale Campaign

Search by campaign name

tag_idsstring

Example:019f94cd-ae21-722b-af36-900a0bb52319,019f94cd-ae21-722b-af36-900b886a25b2

Filter campaigns by tag ids. Returns campaigns that have any of the specified tags assigned. You can specify multiple tag ids by separating them with a comma.

ai_sales_agent_idstring uuid

Example:019f94cd-ae21-722b-af36-900c465a8673

Filter campaigns by AI Sales Agent ID. Returns campaigns that were created by the specified AI Sales Agent.

status-99 | -1 | -2 | 0 | 1 | 2 | 3 | 4

Example:1

Filter campaigns by status using the campaign status enum value (e.g., ACTIVE, PAUSED).

exclude_status-99 | -1 | -2 | 0 | 1 | 2 | 3 | 4

Example:1

Exclude campaigns with this status using the campaign status enum value (e.g., exclude ACTIVE to list only campaigns that are not currently active).

Response

The list of Campaign

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-8394-7231-81aa-6fdeda501906",
      "name": "My First Campaign",
      "pl_value": 100,
      "status": 1,
      "campaign_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
                }
              ]
            }
          ]
        }
      ],
      "timestamp_created": "2026-07-24T15:45:24.372Z",
      "timestamp_updated": "2026-07-24T15:45:24.372Z",
      "email_gap": 10,
      "random_wait_max": 10,
      "email_list": [
        "john@doe.com"
      ],
      "daily_limit": 100,
      "email_tag_list": [
        "019f94cd-8394-7231-81aa-6fdfe913cf6b"
      ],
      "link_tracking": true,
      "open_tracking": true,
      "daily_max_leads": 100,
      "auto_variant_select": {
        "trigger": "click_rate"
      },
      "not_sending_status": 2,
      "limit_emails_per_company_override": {
        "mode": "custom",
        "daily_limit": 3,
        "scope": "per_campaign"
      },
      "cc_list": [
        "john@doe.com"
      ],
      "bcc_list": [
        "john@doe.com"
      ],
      "organization": "019f94cd-8394-7231-81aa-6fe028c6f404",
      "owned_by": "019f94cd-8394-7231-81aa-6fe19097c842",
      "ai_sdr_id": "019f94cd-8394-7231-81aa-6fe227c1bda3",
      "provider_routing_rules": [
        {
          "action": "send",
          "recipient_esp": [
            "all"
          ],
          "sender_esp": [
            "all"
          ]
        }
      ]
    }
  ],
  "next_starting_after": "019f94cd-ae21-722b-af36-900d29f8815e"
}