List campaigns

get/v1/campaigns

This endpoint is in the contract, but the API doesn't serve it during early access. It returns 404 for now.

Campaigns in the org. Read-only in v1. Supports q typeahead (dashboard scope picker and scope_type=campaign).

curl "https://api.vojo-media.com/v1/campaigns" \
  -H "Authorization: Bearer $VOJO_KEY"

// Lists are capped at 100 a page. listAll follows the cursor for you.
for await (const item of listAll((cursor) =>
  api.GET("/v1/campaigns", { params: { query: { cursor, limit: 100 } } }),
)) {
  console.log(item);
}

Response 200

{
  "data": [
    {
      "id": "cm1cmp9d4f0001g6h2j8k3l5sl",
      "name": "Acme Summer 2026",
      "client_id": "cm1cli6x2v0001n4b8m3q7w9rk",
      "start_at": "2026-06-01T00:00:00Z",
      "end_at": "2026-08-31T23:59:59Z",
      "state": "ended",
      "network_wide": false,
      "daily_plays_sold": 1200,
      "total_plays_sold": 110400,
      "expected_plays_timeframe": "daily",
      "total_plays_on_target": "on_target",
      "created_at": "2026-05-20T14:00:00Z"
    }
  ],
  "meta": {
    "next_cursor": "eyJpZCI6ImNtMXNjcjJ3Nm4wMDAxIn0",
    "has_more": true
  }
}

Access

Authentication: Secret key or OAuth access token.
Scope: campaigns:read
User permission: campaignAccessPage

Query parameters

client_idstring
Only this client's campaigns.
statestring
Filter by derived state.
One of upcoming, active, ended
qstring
Case-insensitive substring search on the resource name (typeahead).
1 to 100 characters
cursorstring
Opaque cursor from a previous response's meta.next_cursor. Omit for the first page.
limitinteger
Page size, 1-100. Default 25. A value outside 1-100, or not an integer, is rejected with 400 invalid_request (it is not clamped).
1 to 100
Default 25

Headers

Vojo-Organisationstring
The organisation this request acts on (org id). Required for oauth2 callers — a missing header returns 400 organisation_header_required; an org the user cannot access (a membership or an access grant, and granted to this OAuth client) returns 403 organisation_access_denied. Secret keys are bound to one org: the header may be omitted, and if sent it must match the key's org (else 403). Every query is scoped by the resolved org, never by an id in the body.
Vojo-Versionstring
Optional API version pin (a date). Overrides the version pinned on the secret key / organisation for this request. Echoed in the Vojo-Version response header. Within /v1 only additive changes ship, so most callers can omit it.
date

Response 200

dataarray of objectsRequired
Show 12 fields
- idstringRequired
  Campaign id. Opaque string — treat as an identifier, never parse it.
- namestringRequired
- client_idstringRequired
  Client id. Opaque string — treat as an identifier, never parse it.
- start_atstring or nullRequired
  RFC 3339 / ISO-8601 UTC timestamp, or null.
  date-time
- end_atstring or nullRequired
  RFC 3339 / ISO-8601 UTC timestamp, or null.
  date-time
- statestringRequired
  Derived from start_at / end_at relative to now; not stored.
  One of upcoming, active, ended
- network_widebooleanRequired
- daily_plays_soldintegerRequired
  at least 0
- total_plays_soldintegerRequired
  at least 0
- expected_plays_timeframestringRequired
  Timeframe the campaign's expected plays are measured over.
  One of hourly, daily, weekly, monthly, biweekly
- total_plays_on_targetstringRequired
  Delivery against target.
  One of above_target, on_target, below_target
- created_atstringRequired
  RFC 3339 / ISO-8601 UTC timestamp.
  date-time
metaobjectRequired
Pagination metadata for cursor-paginated lists.
Show 2 fields
- next_cursorstring or nullRequired
  Opaque cursor for the next page. Pass it back as cursor. null when there are no more results.
- has_morebooleanRequired
  True when another page exists (equivalent to next_cursor != null).

Response headers

Vojo-Versionstring
The API version (date) this response was rendered with — the request's Vojo-Version, else the key/org pin.
RateLimitstring
IETF RateLimit header: remaining quota in the current window, e.g. "default";r=97;t=42.
RateLimit-Policystring
IETF RateLimit-Policy header, e.g. "default";q=100;w=60. Portal OAuth clients get a higher tier.

Errors

Every error is application/problem+json. Branch on its code.

400
Malformed request: invalid JSON, a bad cursor, a missing Vojo-Organisation for an OAuth caller, or an unknown Vojo-Version.
401
Missing, invalid, expired or revoked credential.
403
The caller is authenticated but not allowed: missing scope (insufficient_scope), missing Permissions flag (permission_denied), a client/installer persona on an operator endpoint (operator_access_required), or no access to the requested org (organisation_access_denied).
422
Well-formed request that failed validation. errors[] lists each failing field.
429
Rate limit exceeded for this principal. Back off for Retry-After seconds.
500
Unexpected server failure.