---
title: "Stored read: List campaigns"
method: GET
path: "/observe/campaigns"
tags: ["Campaigns"]
---

# Stored read: List campaigns

`GET /observe/campaigns`

## Request

- Base URL: `https://api.adcrunch.dev`
- URL: `https://api.adcrunch.dev/observe/campaigns`
- Auth: HTTP bearer

**Available on:** [![Meta](/providers/meta.svg)](https://docs.adcrunch.dev/connect/providers) [![TikTok](/providers/tiktok.svg)](https://docs.adcrunch.dev/connect/providers) [![Google Ads](/providers/gads.svg)](https://docs.adcrunch.dev/connect/providers) [![OpenAI](/providers/openai.svg)](https://docs.adcrunch.dev/connect/providers)

Lists the campaigns of every ad account your organization connects, across the providers, newest first.

A campaign is a `campaign` at every provider, so this reads them all in one call. Send `provider` to read one platform.

## Paging

`limit` counts rows of the answer itself, not rows of each advertiser, so a `limit` of 10 answers at most 10 rows however many advertisers you own. When the answer holds `nextCursor`, more rows exist: send it back as `cursor` to get the next page. The row that AdCrunch stored last comes first, so a campaign that arrives while you page does not move a page you already read.

## Where a campaign comes from

This is a **stored read**: it answers what AdCrunch holds, which its ingestion refreshes. A campaign a person changed in the provider’s own interface a moment ago may not be here yet — name one advertiser in the path, `/observe/{advertiserId}/campaigns`, to read the provider itself.

## Budget and objective

Every row carries its `budget`, in **whole units** of its `currency` — the unit of `spend` on an Insight — with `budgetType` and `budgetLevel`. `budgetLevel` says whether the budget lives on the campaign or on its ad groups; when it is `ad_group`, read `/observe/ad-groups` for the amounts. `objective` is the provider’s own word, and it is null on a Google Ads campaign, which has none.

A row carries the fields AdCrunch normalizes. For the provider’s own payload, read one campaign by id.

## Query parameters

- `ids` string: Ids to filter on, separated by commas. An id is the bare id its provider gives.
- `cursor` string: The `nextCursor` of the previous page. Omit it to get the first page. Send it with no change, and with the same filters as the request that answered it: a cursor from a different query gets a 400 `invalid_cursor`. Do not build or change a cursor.
- `limit` integer: The greatest number of rows on the page, from 1 to 500. The default is 100. A greater value gets a 400, with `error` of `invalid_request`.
- `advertiserId` string: Read one ad account from what AdCrunch holds, prefixed `acc_`. One your organization does not own answers an empty list rather than a failure. To ask the provider instead, put the advertiser in the path.
- `provider` union: Read one provider. Omit it to read every provider your organization connects.
  - 'meta'
  - 'tiktok'
  - 'snapchat'
  - 'gads'
  - 'dv360'
  - 'x'
  - 'openai'
- `status` 'ACTIVE' | 'PAUSED' | 'DELETED' | 'ARCHIVED': Read one status, normalized across the providers. TikTok `ENABLE` and `DISABLE` are read here as `ACTIVE` and `PAUSED`.

## Response `200`

The matching campaigns, and how many there are in all.

- object
  - `data` object[], required: The matching rows. From the store, the row AdCrunch stored last comes first; from the provider, the provider’s own order. An empty array means nothing matched, which is a normal answer and not a failure.
    - `advertiserId` string, required: The advertiser that owns it, prefixed `acc_`.
    - `createdAt` number, nullable, required: When AdCrunch first stored this row. **Null when the row was read live**: AdCrunch holds no copy of it. `createdAt`, `updatedAt` and `deletedAt` are AdCrunch’s own times, so all three are null together on a live row.
    - `createdTime` number, nullable, required: When the provider created the entity. This is the provider’s own time, so a live row carries it. Null where the provider reports none.
    - `currency` string, nullable, required: The account currency, ISO 4217. Every row of one advertiser carries the same one. Null when AdCrunch does not know it yet.
    - `deletedAt` number, nullable, required: When AdCrunch marked the row deleted. A listing never carries a deleted row, so this is null.
    - `id` string, required: The id the provider gives, with no prefix. It is unique for one provider and one type, and it may legitimately recur across two types or two providers.
    - `name` string, required: The name at the provider.
    - `path` string, required: The ancestors and this entity, ids joined by `/`, oldest first. This is what makes a subtree one string comparison.
    - `provider` string, required: The ad platform: `meta`, `tiktok` or `gads`. Those three are the providers whose entities AdCrunch reads, and https://docs.adcrunch.dev/connect/providers says how deep each one goes.
    - `status` 'ACTIVE' | 'PAUSED' | 'DELETED' | 'ARCHIVED', required: The status, normalized across the providers. TikTok `ENABLE` and `DISABLE` read here as `ACTIVE` and `PAUSED`.
    - `updatedAt` number, nullable, required: When AdCrunch last rewrote this row. Null if it never changed.
    - `updatedTime` number, nullable, required: When the provider last edited the entity. Null where the provider reports none.
    - `adsetBudgetSharing` boolean, nullable, required: Whether the ad sets of this campaign share their daily budgets: Meta ad set budget sharing. Meta refuses a change of bid strategy while it is on. Null on a stored row: AdCrunch keeps the bid in the stored payload only, and a live read answers it. Null at TikTok and Google Ads.
    - `bidStrategy` string, nullable, required: How the provider bids for this entity, in the provider’s word: Meta `LOWEST_COST_WITHOUT_CAP` (Highest volume), `LOWEST_COST_WITH_BID_CAP` (Bid cap), `COST_CAP` (Cost per result goal) or `LOWEST_COST_WITH_MIN_ROAS` (ROAS goal). The strategy sits where the budget sits: on the campaign when the campaign carries the budget, otherwise on each ad set. Null on a stored row: AdCrunch keeps the bid in the stored payload only, and a live read answers it. Null at TikTok and Google Ads, whose bid AdCrunch does not read yet.
    - `budget` number, nullable, required: The budget this entity carries itself, in **whole units** of `currency`: `50` is 50.00, never 50 cents. It is the unit of `spend` on an Insight, so a budget and a spend compare directly. AdCrunch converts each provider’s own unit — Meta’s minor unit, TikTok’s whole units and Google Ads’ micros — so every provider answers the same unit here. Null when the entity carries no budget of its own: `budgetLevel` then says where its budget lives. A campaign answers a budget only when its `budgetLevel` is `campaign`, so a budget always paces delivery at the level that answers it. Null also when AdCrunch does not know the account currency yet, because nobody can read a budget with no currency. At Google Ads one budget may be shared by several campaigns, and each of them answers the whole shared amount. **A stored budget can be older than the rest of the row.** Meta does not mark a campaign changed when only its budget changes, and AdCrunch does not yet follow a Google Ads budget change, so the ingestion can miss a budget edited in the provider’s own interface. A live read answers the budget the provider holds now. AdCrunch takes a budget in the same whole units when it writes one, so a budget you read here goes back with no conversion.
    - `budgetLevel` 'campaign' | 'ad_group', nullable, required: Where the budget of this entity’s campaign lives. `campaign` when the campaign carries it — Meta Advantage campaign budget, TikTok Campaign Budget Optimization, and every Google Ads campaign. `ad_group` when each ad group carries its own. Null on a TikTok campaign whose payload does not say.
    - `budgetType` 'daily' | 'lifetime', nullable, required: `daily` for a budget spent each day, `lifetime` for one spent over the whole life of the entity. Null exactly when `budget` has no provider value to describe.
    - `objective` string, nullable, required: The campaign’s objective, kept as the provider writes it: Meta `OUTCOME_SALES`, TikTok `TRAFFIC`. It is the provider’s word, for the same reason `type` is. Null on every Google Ads campaign, because Google Ads has no objective.
    - `type` string, required: The type the provider uses, kept as the provider writes it: `campaign` at every provider. The resource names the concept, and the row keeps the provider’s own word, because a Meta `adset` and a Google Ads `ad_group` are not the same object.
  - `nextCursor` string: Send this value as `cursor` to get the next page. It is absent on the last page.

## Other responses

- `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.
- `401`: No API key, or one that does not resolve. See the security scheme. `error` is `unauthorized`.
- `402`: The organization has no active subscription. An owner subscribes at `paywallUrl`. `error` is `organization_unentitled`.
- `403`: The caller does not hold `observe:read`. `error` is `forbidden`.

---

[API](https://skmtc.dev/adcrunch/apis/adcrunch-api.md) · [All operations](https://skmtc.dev/adcrunch/apis/adcrunch-api/llms.txt) · [OpenAPI document](https://skmtc.dev/adcrunch/apis/adcrunch-api/revisions/a420ba80914f?raw)