Get organisation subtree

Returns the organisation and every organisation beneath it, one page at a time. Nodes come back ordered so that an organisation always appears after the one above it, which means any page you have received so far rebuilds into a valid tree. The organisation must be the authenticated organisation or a descendant of it.

Paging is forward only. Read hasMore on each reply; while it is true, send the nextCursor value back as the cursor query parameter to fetch the next page.

Path Params
uuid
required

Organisation whose subtree to return. Must be the authenticated organisation or one of its descendants.

Query Params
integer
1 to 100
Defaults to 100

Maximum number of organisations to return. Defaults to 100, which is also the maximum.

string

Cursor for the next page, taken from nextCursor on the previous reply. Send back exactly the value you were given. The format is unspecified and may change between releases, so do not construct, parse or modify one. A cursor minted for a different organisation's subtree is rejected with 400.

Headers
string
required
^\d{4}-\d{2}-\d{2}\.[a-z]+$
Defaults to 2026-10-06.pangolin

The API version the request was built against, as YYYY-MM-DD.animal. Required on every request. See Versioning.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json