Skip to main content
GET
/
campaigns
List campaigns
curl --request GET \
  --url https://api.interchange.io/api/v2/buyer/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "campaigns": [
    {
      "campaignId": "cmp_987654321",
      "advertiserId": "12345",
      "name": "Summer 2025 Campaign",
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-01-20T14:45:00Z",
      "flightDates": {
        "startDate": "2025-01-15T00:00:00Z",
        "endDate": "2025-03-31T23:59:59Z"
      },
      "productCount": 15,
      "budget": {
        "total": 1,
        "currency": "USD"
      }
    }
  ],
  "total": 42
}

Authorizations

​
Authorization
string
header
required

API key or access token

Query Parameters

​
advertiserId
string

Filter by advertiser ID

Example:

"12345"

​
name
string

Filter by campaign name (case-insensitive, partial match)

Example:

"Summer"

​
status

Filter by campaign status

Available options:
DRAFT,
ACTIVE,
PAUSED,
COMPLETED,
ARCHIVED
​
mediaBuyStatus

Filter to only campaigns that have at least one media buy matching any of the given statuses

Available options:
DRAFT,
PENDING_APPROVAL,
INPUT_REQUIRED,
ACTIVE,
PAUSED,
COMPLETED,
CANCELED,
FAILED,
REJECTED,
ARCHIVED
​
includeArchived
enum<string>

Include archived (soft-deleted) campaigns in the response (default: false). Implicitly treated as true when the status filter contains 'ARCHIVED'.

Available options:
true,
false
​
take
integer
default:50

Number of results to return (max 250)

Required range: x <= 250
Example:

50

​
skip
integer
default:0

Number of results to skip for pagination

Required range: 0 <= x <= 9007199254740991
Example:

0

Response

List campaigns

Response containing a paginated list of campaign summaries

​
campaigns
object[]
required

Campaigns matching the query, projected to the summary shape. Use get_campaign for full detail.

​
total
integer
required

Total count of campaigns matching the query

Required range: 0 <= x <= 9007199254740991
Example:

42