---
title: "Get a campaign"
method: GET
path: "/api/v1/campaigns/{id}"
tags: ["campaigns"]
---

# Get a campaign

`GET /api/v1/campaigns/{id}`

## Request

- Base URL: `https://api.growomat.com`
- URL: `https://api.growomat.com/api/v1/campaigns/{id}`
- Auth: HTTP bearer

Returns the campaign with everything needed to act on it.

- `delivery`: one entry per platform the campaign runs on, with its `state`, the `reasons[]` behind that state (cause first), and `since`.
- `deliverySummary`: the worst of those states, with its platform and reasons. This is the answer to "is it serving, and if not, why?".
- `adScheduleStructured`: the weekly schedule as stored (`windows[]` plus `timezone`), present once a schedule has been set.
- `adSchedule`: the schedule as you last wrote it, either a preset name or the structured object.
- `_platformBudgets`: where the campaign runs and how the budget is shared, as you set it.

States: `SERVING`, `LEARNING`, `LIMITED_BUDGET`, `NOT_SERVING`, `NOT_LIVE_YET`, `NOT_EXPORTED`, `PAUSED`, `ENDED`. A campaign that has never been synced is `NOT_EXPORTED`.

**Errors**

- `404 NOT_FOUND`: no campaign with this id in the active Space.

## Path parameters

- `id` string, required

## Headers

- `X-Space-Id` string

## Response `200`

OK. The result is in `data`. List responses also carry `meta` with `nextCursor` and `total`.

- SuccessEnvelope: The shape of every successful response.
  - `data` unknown, required
  - `meta` object: Present on list responses.
    - `nextCursor` union: Pass as `cursor` to get the next page. `null` on the last page.
      - string
      - number
    - `total` integer: Number of items in this page.

## Other responses

- `400`: The request is malformed or fails validation. `error.code` is `VALIDATION_ERROR` (with `details.issues[]` naming each field), `INVALID_REQUEST` (the body is not valid JSON or has the wrong shape), or one of the specific codes listed in this operation's description.
- `401`: The bearer token is missing, invalid, expired or revoked (`INVALID_TOKEN`).
- `403`: The token lacks the scope this operation needs (`INSUFFICIENT_SCOPE`), the plan is read-only (`READ_ONLY_MODE`), or the caller is not a member of the Space named in `X-Space-Id` (`NOT_A_MEMBER`).
- `404`: No such resource in the active Space (`NOT_FOUND`), or `X-Space-Id` names a Space that does not exist (`SPACE_NOT_FOUND`).
- `409`: The request conflicts with the current state, for example a delete blocked by dependents or a sync already running. This operation's description names the `error.code` values it can return.
- `429`: Too many requests (`RATE_LIMITED`). Wait for the number of seconds in the `Retry-After` header, then retry.

---

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