Skip to main content
GET
Get Campaign by ID

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaign_id
string<uuid>
required

The ID of the campaign to get

Response

Success

id
string<uuid>
required

The ID of the campaign

startDate
string
required

The start date of the campaign, format: 'YYYY-MM-DD'

endDate
string | null
required

The end date of the campaign, format: 'YYYY-MM-DD'. If null, the campaign will continue indefinitely (until budget is reached, or canceled).

cancellationDate
string | null
required

The cancellation date of the campaign, format: 'YYYY-MM-DD'. If null, the campaign has not been canceled.

product
object
required
brandId
string<uuid>
required
budget
object
required

Information about the campaign's budget, including the amount of clicks remaining, and whether or not the budget has been reached

membership
object | null
required

Information about your membership in this campaign. If null, you have not joined the campaign