Campaigns

Read-only access to campaigns

Get campaign by UUID

get

https://api.teeinblue.com/openapi/v1https://staging-api.teeinblue.com/openapi/v1

/campaigns/{campaignId}

Fetch a single campaign by UUID and platformDomain. Requires campaigns:read ability.

Authorizations

bearerAuth

AuthorizationstringRequired

Include Authorization: Bearer <token> header. Token must have the orders:read ability.

Path parameters

UUIDstringRequired

Campaign UUID (e.g., 6d823e4d-8f21-41f8-b461-e97c981880bc)

Query parameters

shopstringRequired

The platform domain of the shop

Example: my-shop.myshopify.com

Responses

200

Campaign found

application/json

Details of a campaign by platform.

idintegerOptional

Unique identifier for this campaign

Example: 1234567890

uuidstringOptional

Unique identifier for this campaign

Example: 6d823e4d-8f21-41f8-b461-e97c981880bc

instance_idnumberOptional

Instance ID of the campaign

Example: 1234567890

platform_linked_idnumberOptional

Platform linked ID of the campaign

Example: 1234567890

namestringOptional

Name of the campaign

Example: My Campaign

preview_urlstringOptional

Preview URL of the campaign

Example: https://cdn.teeinblue.com/examples/platform-mockups/preview.png

preview_thumbnailstringOptional

Preview thumbnail of the campaign

Example: https://cdn.teeinblue.com/examples/platform-mockups/thumbnail.webp

versionnumberOptional

Version of the campaign

Example: 1

enable_artwork_variant_assignmentbooleanOptional

Whether artwork variant assignment is enabled

Example: true

published_atstring · date-timeOptional

Timestamp when the campaign was published

Example: 2025-01-15T10:30:00Z

created_atstring · date-timeOptional

Timestamp when the campaign was created

Example: 2025-01-15T10:30:00Z

updated_atstring · date-timeOptional

Timestamp when the campaign was last updated

Example: 2025-01-15T10:30:00Z

401

Missing or invalid authentication

application/json

403

Authenticated but lacking required ability

application/json

404

Campaign not found

application/json

get

/campaigns/{campaignId}

HTTPcURLJavaScriptPython

GET /openapi/v1/campaigns/{campaignId}?shop=text HTTP/1.1
Host: api.teeinblue.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1234567890,
  "uuid": "6d823e4d-8f21-41f8-b461-e97c981880bc",
  "instance_id": 1234567890,
  "platform_linked_id": 1234567890,
  "name": "My Campaign",
  "preview_url": "https://cdn.teeinblue.com/examples/platform-mockups/preview.png",
  "preview_thumbnail": "https://cdn.teeinblue.com/examples/platform-mockups/thumbnail.webp",
  "version": 1,
  "enable_artwork_variant_assignment": true,
  "published_at": "2025-01-15T10:30:00Z",
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T10:30:00Z",
  "artworks": [
    {
      "id": 1234567890,
      "name": "My Artwork",
      "description": "My Artwork Description",
      "width": 1000,
      "height": 1000,
      "thumbnail": "https://cdn.teeinblue.com/examples/platform-mockups/thumbnail.webp",
      "status": 1,
      "position": 1,
      "platform_variants_id": [
        1234567890,
        1234567891
      ]
    }
  ],
  "mockups": [
    {
      "id": 1234567890,
      "width": 1000,
      "height": 1000,
      "platform_variants_id": [
        1234567890,
        1234567891
      ],
      "preview_url": "https://cdn.teeinblue.com/examples/platform-mockups/preview.png",
      "preview_thumbnail": "https://cdn.teeinblue.com/examples/platform-mockups/thumbnail.webp"
    }
  ]
}