List Campaigns
GET/campaigns
Returns a paginated list of campaigns belonging to the authenticated brand.
Results are filtered to only include non-deleted campaigns owned by your brand (determined by your API key).
Pagination​
Use page and pageSize query parameters to paginate through results. The response includes a meta.pagination object with total counts and page information.
Filtering​
| Parameter | Description | Example |
|---|---|---|
type | Filter by campaign type | ?type=campaign |
live | Filter by live status | ?live=true |
Sorting​
Use the sort parameter with format field:direction. Allowed fields: createdAt, updatedAt, name, dateStart, dateEnd.
Example: ?sort=name:asc
Request​
Responses​
- 200
- 401
- 429
Campaigns retrieved successfully
Response Headers
The maximum number of requests allowed per minute
The number of requests remaining in the current window
Unix timestamp when the rate limit window resets
Unauthorized - Invalid or missing API key
Rate limit exceeded
Response Headers
The maximum number of requests allowed per minute
The number of requests remaining in the current window
Unix timestamp when the rate limit window resets
Seconds until the rate limit resets (only on 429 responses)