Skip to main content
GET /api/v2/buyer/campaigns/:id Returns the complete campaign resource — brief, media buys, audiences, fees, pacing, performance config, and frequency caps. GET augments the campaign with creativeFormats so you can confirm format coverage before execution.

​
Request

curl https://api.interchange.io/api/v2/buyer/campaigns/cmp_987654321 \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

​
Parameters

FieldTypeRequiredNotes
idstringYesPath parameter — the campaign identifier
mediaBuyIdstringNoQuery parameter. Filter the embedded mediaBuys[] to only these media buys. Accepts a single value or repeated values. The campaign itself is unchanged; only the nested media buys are narrowed.
includePropertyListsbooleanNoQuery parameter. When true, embed a propertyLists aggregate showing the include/exclude lists applied to this campaign. Defaults to false.

​
Response

{
  "campaign": {
    "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", "pacing": "EVEN" },
    "mediaBudget": { "total": 92000, "currency": "USD" },
    "allocatedBudget": 60000,
    "unallocatedBudget": 32000,
    "optimizationApplyMode": "MANUAL",
    "mediaBuyRefs": [
      { "mediaBuyId": "mb_abc123", "status": "ACTIVE" }
    ],
    "mediaBuys": [
      {
        "mediaBuyId": "mb_abc123",
        "name": "Q2 2026 Tech Launch - Example Media",
        "status": "ACTIVE",
        "createdAt": "2026-05-01T09:00:00Z",
        "updatedAt": "2026-05-15T12:00:00Z"
      }
    ],
    "creativeFormats": {
      "required": [{ "agent_url": "https://agent.example.com", "id": "video_15s" }, { "agent_url": "https://agent.example.com", "id": "video_30s" }],
      "covered": [{ "agent_url": "https://agent.example.com", "id": "video_15s" }],
      "missing": [{ "agent_url": "https://agent.example.com", "id": "video_30s" }]
    },
    "createdAt": "2026-05-01T09:00:00Z",
    "updatedAt": "2026-05-15T12:00:00Z"
  }
}
campaign.creativeFormats.missing lists formats that still need creatives — check it is empty before executing. campaign.mediaBuys[] is populated only after the campaign has been executed (post-DRAFT). For a lightweight scan across many campaigns, use List campaigns, which returns a compact summary instead of the full resource.

​
Errors

  • 404 NOT_FOUND — no campaign with this ID is visible to the authenticated customer.
See Errors for the full error contract.

List campaigns

Compact summaries across campaigns

Update campaign

Change a campaign or its media buys

Get media buy status

Poll live ADCP status

Campaign overview

Fields, lifecycle, and concepts