List Campaigns

List your custom campaigns with their type, sfdcCampaignId, and member count. Only custom campaigns are exposed by this API; webinars and blasts are not returned. Archived campaigns are excluded. Member statuses are not included here; fetch them as type.statuses from GET /v2/campaigns/{campaignId}.

Results are paginated with an opaque cursor returned as pagination.nextCursor. Pass it back as the cursor query parameter to fetch the next page.

get/v2/campaigns

Request

Base URL
https://pub-api.conversion.ai/api
Auth
- API key in header X-API-Key
- or API key in query parameter api_key

Query parameters

limitinteger

The maximum number of campaigns to return per page. Values outside [1, 100] are clamped rather than rejected.

cursorstring

The opaque pagination cursor returned as pagination.nextCursor by a previous call. Omit to fetch the first page. An invalid or malformed cursor returns an invalid_cursor error.

Response

Campaigns retrieved successfully.

Example response

{
  "data": {
    "campaigns": [
      {
        "id": "b7c8d9e0-f1a2-3456-bcde-f01234567890",
        "name": "Q3 Field Events",
        "type": {
          "id": "3c9d2b1a-8e4f-4a6b-9c0d-2e3f4a5b6c7d",
          "name": "Field Event"
        },
        "sfdcCampaignId": "701Ho00000AbCdEfGH",
        "memberCount": 42
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.