Get the active organisation

get/v1/organisation

The organisation this request acts on (the Vojo-Organisation header, or the secret key's bound org). Lets a key holder confirm which org it is bound to. Any valid token or key may call it — no specific scope is required.

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

const { data, error } = await api.GET("/v1/organisation");
if (error) throw new VojoApiError(error);

Response 200

{
  "data": {
    "id": "cm1org8k2q0001x7v3n9p4d2fa",
    "name": "Northwind Media",
    "email": "[email protected]",
    "is_active": true,
    "api_version": "2026-10-07",
    "created_at": "2025-03-02T10:00:00Z"
  },
  "meta": {}
}

Access

Authentication: Secret key or OAuth access token.
User permission: Membership of the organisation is enough.

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
An organisation (tenant).
Show 6 fields
- idstringRequired
  Organisation id. Opaque string — treat as an identifier, never parse it.
- namestringRequired
- emailstringRequired
  Contact email.
  email
- is_activebooleanRequired
- api_versionstring or nullRequired
  Default API version pin for this org (date), used when neither the key nor the request pins one.
  date
- created_atstring or nullRequired
  RFC 3339 / ISO-8601 UTC timestamp, or null.
  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.

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).
429
Rate limit exceeded for this principal. Back off for Retry-After seconds.
500
Unexpected server failure.