Get a campaign

Get campaign

get

Get a previously created campaign using its identifier.

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstring · uuidRequired

The ID for the workspace.

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

brandIdstringRequired

A unique identifier for the brand.

campaignIdstringRequired

A unique identifier for the campaign.

Responses

200

Campaign found

application/json

404

Campaign or brand not found

application/json

get

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

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/tcr-brands/{brandId}/campaigns/{campaignId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "subscription": {
    "status": "active",
    "subscribedAt": "2025-12-19T13:55:33.902Z",
    "updatedAt": "2025-12-19T13:55:33.902Z",
    "cancelledAt": "2025-12-19T13:55:33.902Z"
  },
  "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-12-19T13:55:33.902Z",
      "updatedAt": "2025-12-19T13:55:33.902Z",
      "filename": "attachment.txt",
      "mediaUrl": "https://example.com/attachment.txt",
      "contentType": "text/plain"
    }
  ],
  "createdAt": "2025-12-19T13:55:33.902Z",
  "updatedAt": "2025-12-19T13:55:33.902Z"
}

Type	Description
CampaignReponse	CampaignResponse object describes a submitted campaign