List advertisements

get/v1/advertisements

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

Advertisements in the org. Archived ads are hidden by default; list them with is_active=false.

curl "https://api.vojo-media.com/v1/advertisements" \
  -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/advertisements", { params: { query: { cursor, limit: 100 } } }),
)) {
  console.log(item);
}

Response 200

{
  "data": [
    {
      "id": "cm1adv3z7x0001c5v9b2n6m4tm",
      "name": "Acme Summer 15s",
      "description": "Portrait cut",
      "type": "video",
      "client_id": "cm1cli6x2v0001n4b8m3q7w9rk",
      "is_active": true,
      "size_bytes": 18874368,
      "length": 15,
      "thumbnail_url": "https://cdn.vojo-media.com/thumbs/cm1adv3z7x0001c5v9b2n6m4tm.jpg",
      "source_url": "https://spaces.vojo-media.com/cm1org8k2q0001x7v3n9p4d2fa/9b1e.mp4?X-Amz-Expires=900&X-Amz-Signature=4f0c2a9d",
      "tags": [
        "summer",
        "portrait"
      ],
      "uploaded_by_user_id": "cm1usr3h7t0001k2m8q4w6z9ab",
      "created_at": "2026-09-14T08:12:45Z",
      "updated_at": "2026-10-07T09:30:00Z"
    }
  ],
  "meta": {
    "next_cursor": "eyJpZCI6ImNtMXNjcjJ3Nm4wMDAxIn0",
    "has_more": true
  }
}

Access

Authentication: Secret key or OAuth access token.
Scope: advertisements:read
User permission: advertisementAccessPage

Query parameters

client_idstring
Only this client's ads.
typestring
Media type.
One of video, image, html
is_activeboolean
False lists archived ads.
Default true
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 14 fields
- idstringRequired
  Advertisement id. Opaque string — treat as an identifier, never parse it.
- namestringRequired
- descriptionstring or nullRequired
  up to 100 characters
- typestringRequired
  Creative media type.
  One of video, image, html
- client_idstring or nullRequired
- is_activebooleanRequired
  False once archived via DELETE.
- size_bytesinteger or nullRequired
  Measured from storage (HeadObject); never client-supplied.
- lengthnumber or nullRequired
  Duration in seconds (video/HTML).
- thumbnail_urlstring or nullRequired
  uri
- source_urlstring or nullRequired
  Short-lived signed GET URL for the media. Present only when the caller has advertisementViewSource; otherwise null.
  uri
- tagsarray of stringRequired
- uploaded_by_user_idstringRequired
  The person who uploaded it (for a secret key, the key's creator).
- created_atstringRequired
  RFC 3339 / ISO-8601 UTC timestamp.
  date-time
- updated_atstring or nullRequired
  RFC 3339 / ISO-8601 UTC timestamp, or null.
  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.