Skip to content
AdCrunch
Esc
↑↓navigate↵open⌘Jpreview

List the Campaign Plans

Lists the Campaign Plans of your organization, newest first. Each row gives the figures you compare plans by: the budget envelope, the allocated sum and whether that sum is comparable, the window, the number of lines, and the channels the Campaign Plan uses. This call does not give the Line Items. To read them, read one plan. Deleted plans are not in the list.

One page at a time: limit rows at most, 100 by default. When the answer holds nextCursor, more rows exist: send it back as cursor to get the next page.

GET/context/campaign-plans
Authorization
AuthorizationBearer token · headerrequired

Send Authorization: Bearer <credential>.

Use an API key (acr_…), from the AdCrunch console under Settings → API keys.

The credential names the organization, and no operation takes an organization parameter.

See https://docs.adcrunch.dev/api/authentication.

Query parameters
cursorstring
min length 1
limitintegerrequired
min 1 · max 500 · default: 100
Responses
200

One page of the Campaign Plans of the organization, newest first, with the money of each summarized and its channels named, but without its rows. Where the rows mix totals and daily rates, allocation.comparable is false and allocation.allocated is null — there is no meaningful sum to show. This page is the last one, so it carries no nextCursor.

dataobject[]required
Show properties
Array of object
allocationobjectrequired

Derived on every read. Never stored.

Show properties
allocatednumber | nullrequired

The sum of the Line Item budgets. null when the lines mix units, because that sum would be meaningless.

comparablebooleanrequired

False when the lines mix totals and daily rates. A surface must then print "not comparable" rather than a plausible-looking wrong total.

unallocatednumber | nullrequired

The envelope less the allocated, where both are known.

unitstring | nullrequired

The shared unit, when the lines agree on one.

Allowed:totaldaily
brandIdstring | nullrequired
channelsstring[]required

Every channel its Line Items name, deduplicated.

currencystringrequired
descriptionstringrequired
endDatestring | nullrequired

A calendar date, YYYY-MM-DD.

lineItemCountnumberrequired
namestringrequired
revisionnumberrequired

Increments on every write. Send it back as base_revision to edit; a stale one answers 409.

slugstringrequired
startDatestring | nullrequired

A calendar date, YYYY-MM-DD.

statusstringrequired
Allowed:draftapproved
totalBudgetnumber | nullrequired

The envelope. Whole units of currency.

nextCursorstring

Send this value as cursor to get the next page. It is absent on the last page.

400

The request does not match the schema of this operation: a field is missing or has the wrong type, or the body is not valid JSON. error is invalid_request, and issues names each field. Nothing was changed. Or AdCrunch cannot use the cursor: it cannot read it, or the cursor belongs to a different query. Then error is invalid_cursor. Send the nextCursor of the previous page with no change, or omit cursor to get the first page.

Any of:
object
issuesobject[]required

One entry for each field that does not match.

Show properties
Array of object
instringrequired

The part of the request that holds the field.

Allowed:bodycookieheadersparamsquery
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

pathstringrequired

A JSON Pointer into that part of the request, such as /filename. An empty string is the whole part.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:invalid_request
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

object
errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:invalid_cursor
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

401

No API key, or one that does not resolve. See the security scheme. error is unauthorized.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:unauthorized
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

403

The caller does not hold campaign_plan:read. error is forbidden.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:forbidden
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

Request
curl -X GET "https://api.pr-701.adcrunch.dev/context/campaign-plans?limit=100" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "data": [
    {
      "allocation": {
        "allocated": 2500,
        "comparable": true,
        "unallocated": 2500,
        "unit": "total"
      },
      "brandId": "brd_6a9c33",
      "channels": [
        "meta"
      ],
      "currency": "EUR",
      "description": "The spring sale of Acme, on Meta, in France and Belgium.",
      "endDate": "2026-05-31",
      "lineItemCount": 1,
      "name": "Spring Sale 2026",
      "revision": 3,
      "slug": "spring-sale",
      "startDate": "2026-03-01",
      "status": "approved",
      "totalBudget": 5000
    }
  ]
}