API

Search the developer hub

Jump to a page or an endpoint.

Organisation

The organisation an API key belongs to.

Every API key belongs to exactly one organisation. This call says which, and what the key is allowed to do, so it is the first thing to call when you set up an integration.

id is the organisation's public id. It is the same organisationId that webhook payloads carry, so you can match events to the key that reads them.

GET/api/v1/organisation

The organisation an API key belongs to, and what the key may do. The quickest way to check a key works.

  • Beta — still moving. Changes are announced in the changelog before they ship.
  • Needs an API key. Call it from your server, never a browser.
  • Works with read-only and read and write keys.

Headers

NameRequiredDescription
AuthorizationYesYour API key as a bearer token: `Bearer ops25_sk_…`.

Errors

StatusWhen
401The key is missing, malformed or revoked.
429More than 600 requests from this key in a minute.