List all campaigns

List campaigns

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.

GET/workspaces/{workspaceId}/tcr-brands/{brandId}/campaigns

Authorization

useraccessKey

Path parameters

workspaceId*WorkspaceId (string (uuid))

The ID for the workspace.

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

brandId*string

A unique identifier for the brand.

Query parameters

Response

200404

OK

Body

application/json

results*array of Campaign (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display. To know more, refer to the pagination section.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/tcr-brands/{brandId}/campaigns', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "subscription": {
        "status": "active",
        "subscribedAt": "2024-12-08T00:51:21.855Z",
        "updatedAt": "2024-12-08T00:51:21.855Z",
        "cancelledAt": "2024-12-08T00:51:21.855Z"
      },
      "status": "DRAFT",
      "usecase": "text",
      "subUsecases": [
        "text"
      ],
      "description": "text",
      "embeddedLink": false,
      "embeddedPhone": false,
      "numberPool": false,
      "ageGated": false,
      "directLending": false,
      "subscriberOptin": false,
      "subscriberOptout": false,
      "subscriberHelp": false,
      "samples": [
        "text"
      ],
      "messageFlow": "text",
      "helpMessage": "text",
      "helpKeywords": "text",
      "optoutKeywords": "text",
      "optinKeywords": "text",
      "optinMessage": "text",
      "optoutMessage": "text",
      "termsAndConditions": false,
      "brandId": "123e4567-e89b-12d3-a456-426614174000",
      "rejection": {
        "description": "text",
        "code": "text"
      },
      "attachments": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "status": "PENDING",
          "createdAt": "2024-12-08T00:51:21.855Z",
          "updatedAt": "2024-12-08T00:51:21.855Z",
          "filename": "attachment.txt",
          "contentType": "text/plain"
        }
      ],
      "createdAt": "2024-12-08T00:51:21.855Z",
      "updatedAt": "2024-12-08T00:51:21.855Z"
    }
  ],
  "nextPageToken": "text"
}

Type	Description
array<CampaignReponse>	CampaignResponse object describes a submitted campaign