Skip to main content
GET
/
vendor
/
campaigns
/
{id}
Get campaign
curl --request GET \
  --url https://api.example.com/vendor/campaigns/{id} \
  --header 'Authorization: Bearer <token>'
{
  "campaign": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "currency": "<string>",
    "campaign_identifier": "<string>",
    "starts_at": "<string>",
    "ends_at": "<string>",
    "budget": {
      "id": "<string>",
      "type": "spend",
      "currency_code": "<string>",
      "limit": 123,
      "used": 123
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The ID of the campaign.

Query Parameters

​
fields
string

Comma-separated fields to include in the response. Use *promotions or promotions.* to include promotions.

​
q
string

Search query to filter promotions by code (case-insensitive partial match).

​
created_at
string

Filter promotions by created_at date. Must be a JSON object (URL-encoded) with comparison operators. Supported operators: $gte, $lte, $gt, $lt, $eq, $ne. Example: {"$gte":"2025-11-19T11:00:00.000Z"} (URL-encoded: %7B%22%24gte%22%3A%222025-11-19T11%3A00%3A00.000Z%22%7D)

​
updated_at
string

Filter promotions by updated_at date. Must be a JSON object (URL-encoded) with comparison operators. Supported operators: $gte, $lte, $gt, $lt, $eq, $ne. Example: {"$gte":"2025-11-19T11:00:00.000Z"} (URL-encoded: %7B%22%24gte%22%3A%222025-11-19T11%3A00%3A00.000Z%22%7D)

​
order
string

Sort promotions by property. Prefix with - for descending order. Examples: code, -code, created_at, -created_at, updated_at, -updated_at

​
offset
number

The number of promotions to skip before starting to collect the result set.

​
limit
number

The number of promotions to return.

Response

200 - application/json

OK

​
campaign
object

The campaign's details.