Skip to main content
GET /api/v2/buyer/campaigns Returns campaigns in a compact summary shape — identity, status, flight dates, flattened budget, and product count. Filter by advertiser and status. Use Get campaign for the full resource.

Request

curl "https://api.interchange.io/api/v2/buyer/campaigns?advertiserId=12345&status=ACTIVE" \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

Parameters

FieldTypeRequiredNotes
advertiserIdstringNoQuery param — filter to one advertiser
namestringNoQuery param — case-insensitive partial match on campaign name
statusenumNoQuery param — DRAFT, ACTIVE, PAUSED, COMPLETED, or ARCHIVED. Accepts a single value or repeated values
mediaBuyStatusenumNoQuery param — filter to campaigns that have at least one media buy in any of the given statuses. Accepts a single value or repeated values
includeArchivedbooleanNoQuery param — when true, include archived campaigns (default false). Implicitly true when status=ARCHIVED
takeintegerNoQuery param — page size
skipintegerNoQuery param — offset for pagination (default 0)

Response

{
  "campaigns": [
    {
      "campaignId": "cmp_987654321",
      "advertiserId": "12345",
      "name": "Q2 2026 Tech Launch",
      "status": "ACTIVE",
      "campaignType": "DECISIONED",
      "flightDates": { "startDate": "2026-05-15T00:00:00Z", "endDate": "2026-07-15T23:59:59Z" },
      "budget": { "total": 100000, "currency": "USD" },
      "productCount": 8,
      "createdAt": "2026-05-01T09:00:00Z",
      "updatedAt": "2026-05-15T12:00:00Z"
    }
  ],
  "total": 1
}
Each entry is a summary, not the full resource — mediaBuys, audiences, fees, and creativeFormats are omitted. total is the count across all pages. Results use offset pagination (take / skip); see Pagination.

Errors

  • 400 VALIDATION_ERROR — invalid status value.
See Errors for the full error contract.

Get campaign

Full resource for one campaign

Create campaign

Open a new DRAFT campaign

Pagination

Offset-based list paging

Campaign overview

Fields, lifecycle, and concepts