Skip to main content
GET
Get campaign

Authorizations

Authorization
string
header
required

Enter your JWT token in the format: Bearer

Path Parameters

id
string<uuid>
required

A UUID string identifying this Campaign.

Query Parameters

include
string

Comma-separated related sections to include. Available: workflow, events, inventory_bookings, advert_clearances, delivery_logs, reports, invoices. invoices are fetched live from payment-service. Omit to receive base fields + workflow only.

Response

200 - application/json

Campaign Detail Serializer

id
string<uuid>
required
read-only
start_date
string<date>
required

Campaign start date

end_date
string<date>
required

Campaign end date

status
string
required

Lead status

Maximum string length: 50
node
string
required

Workflow Node

Maximum string length: 50
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
engine_request
string
required

Workflow Engine request

Maximum string length: 20
workflow
string
required
read-only
reference
string | null

Generated reference string

Maximum string length: 30
name
string

Campaign name (captured at client commitment)

Maximum string length: 255
metadata
any

Campaign metadata