Get a wrapper

get/v1/wrappers/{wrapper_id}

Returns a wrapper and its status. Use it to poll a wrapper that POST /v1/wrappers returned with 202 until it is ready or failed.

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

const { data, error } = await api.GET("/v1/wrappers/{wrapper_id}", {
  params: { path: { wrapper_id: wrapperId } },
});
if (error) throw new VojoApiError(error);

Response 200

{
  "data": {
    "id": "cm1wrp2e6r0001t9y5u3i8o4wp",
    "status": "ready",
    "failure": null,
    "delivery_mode": "archive",
    "url": "https://cdn.vojo-media.com/wrappers/cm1wrp2e6r0001t9y5u3i8o4wp.html",
    "html": null,
    "fingerprint_id": "cm1fpr6y2u0001o8p4a7s3d9yr",
    "fingerprint": "3-7-1-5-2-8",
    "metadata": {
      "line_item": "LI-2291"
    },
    "created_at": "2026-10-07T09:30:00Z"
  },
  "meta": {}
}

Access

Authentication: Secret key or OAuth access token.
Scope: wrappers:write
User permission: advertisementAddNew

Path parameters

wrapper_idstringRequired

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

dataobjectRequired
A Vojo Passport wrapper. Wrapping can finish inside the create request (status: ready) or continue in the background (status: processing); integrators must handle both.
Show 10 fields
- idstringRequired
  Wrapper id. Opaque string — treat as an identifier, never parse it.
- statusstringRequired
  processing: the wrap is still being built — url, html and the fingerprint fields are null until it is ready. Poll GET /v1/wrappers/{wrapper_id} or subscribe to the wrapper.ready / wrapper.failed webhooks. Clients must tolerate new values.
  One of processing, ready, failed
- failureobject or nullRequired
  Why the wrap failed; null unless status is failed.
  Show 2 fields
  - codestringRequired
    Stable error code from the API error registry (e.g. creative_fetch_failed).
  - detailstringRequired
- delivery_modestringRequired
  inline returns the wrapper HTML in the response; archive stores it and returns a URL.
  One of inline, archive
- urlstring or nullRequired
  Archived wrapper URL (archive mode); null for inline.
  uri
- htmlstring or nullRequired
  Wrapper HTML (inline mode); null for archive.
- fingerprint_idstring or nullRequired
- fingerprintstring or nullRequired
  Fingerprint code burned into the wrapper, when requested.
- metadataobject or nullRequired
- created_atstringRequired
  RFC 3339 / ISO-8601 UTC timestamp.
  date-time
metaobjectRequired
Response metadata for single-resource responses. Reserved; currently empty. Clients must ignore unknown members.

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.

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).
404
The resource does not exist, or belongs to another organisation. Cross-org ids always 404, never 403.
429
Rate limit exceeded for this principal. Back off for Retry-After seconds.
500
Unexpected server failure.