List all campaigns

Last updated 9 months ago

Was this helpful?

List campaigns

get

List all campaigns for a given brand. The list can be filtered by campaign status. This result is paginated. To learn more about the pagination, please refer to the pagination section on API Access Common API Usage section.

Authorizations

Path parameters

workspaceIdstring · uuidRequired

The ID for the workspace.

Example: d386a801-ee8d-4aba-a7e4-78671bd3b11e

brandIdstringRequired

A unique identifier for the brand.

Query parameters

limitinteger · min: 1 · max: 99Optional

Limits the number of results to return per page. The default value is 10 and maximum is 99. If the nextPageToken is defined on response, you can use it to get remaining numbers. To know more, refer to the pagination section.

Default: 10

pageTokenstring · max: 8000Optional

Pagination token that keeps of track of the current position in the list. Use it to query remaining results. If not provided, the first page is returned. To learn more about the pagination, please refer to the pagination section on API Access Common API Usage section.

reversebooleanOptional

Order in which to retrieve the results. By default, the orders are in ascending order date. To get the results in descending order, set this parameter to true.

Default: false

Responses

200

application/json

Responseall of

404

Brand not found

application/json

get

GET /workspaces/{workspaceId}/tcr-brands/{brandId}/campaigns HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "subscription": {
        "status": "active",
        "subscribedAt": "2025-06-20T17:18:54.254Z",
        "updatedAt": "2025-06-20T17:18:54.254Z",
        "cancelledAt": "2025-06-20T17:18:54.254Z"
      },
      "status": "DRAFT",
      "usecase": "text",
      "subUsecases": [
        "text"
      ],
      "description": "text",
      "embeddedLink": true,
      "embeddedPhone": true,
      "numberPool": true,
      "ageGated": true,
      "directLending": true,
      "subscriberOptin": true,
      "subscriberOptout": true,
      "subscriberHelp": true,
      "samples": [
        "text"
      ],
      "messageFlow": "text",
      "helpMessage": "text",
      "helpKeywords": "text",
      "optoutKeywords": "text",
      "optinKeywords": "text",
      "optinMessage": "text",
      "optoutMessage": "text",
      "termsAndConditions": true,
      "brandId": "123e4567-e89b-12d3-a456-426614174000",
      "resellerId": "text",
      "rejection": {
        "description": "text",
        "code": "text"
      },
      "attachments": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "status": "PENDING",
          "createdAt": "2025-06-20T17:18:54.254Z",
          "updatedAt": "2025-06-20T17:18:54.254Z",
          "filename": "attachment.txt",
          "mediaUrl": "https://example.com/attachment.txt",
          "contentType": "text/plain"
        }
      ],
      "createdAt": "2025-06-20T17:18:54.254Z",
      "updatedAt": "2025-06-20T17:18:54.254Z"
    }
  ],
  "nextPageToken": "text"
}