tenancy

GET /v1/orgs

List organizations in scope.

All tenancy endpoints

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/orgs \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Lists the organizations the principal can access, walking the tenancy tree. Cursor-paginated. RLS guarantees no organization outside the principal's subtree is ever returned (CLAUDE.md §2.3).

Parameters

NameTypeRequiredWhat it is
cursor (query)stringNoOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerNoMaximum items to return (page size).
type (query)OrgTypeNoFilter by organization type.

Response

NameTypeRequiredWhat it is
dataOrganization[]Yes
pagePageMetaYes

Errors this endpoint can return

401 · 429