Skip to navigation

List zones

List the organization’s zones (Production, Staging, …). Pass an zone’s id or name as the zone query parameter on other endpoints to work inside it. Every organization has a Production zone, used when zone is omitted.

Authentication

AuthorizationBearer

WorkOS API key (Authorization: Bearer sk_…). Scope comes from the key’s permissions: a key carrying passport:admin has admin scope (full catalog CRUD), any other key has member scope (reads + access requests). Organization-owned keys are admin by ownership and carry no associated user; keys minted for a user carry theirs, which is what access requests and createdBy are attributed to.

Response headers

RateLimit-LimitintegerOptional
Requests allowed in the current window.
RateLimit-RemainingintegerOptional
Requests remaining in the current window.
RateLimit-ResetintegerOptional
Unix epoch seconds when the window resets.

Response

OK
datalist of objects

Errors

401
Unauthorized Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error