Skip to main content
Request example
Response example
GET /api/external/sub_orgs/?limit={limit}&cursor={cursor}&name={name} Returns the sub-orgs visible to the authenticated API user. Results are scoped to the organization, exclude deleted rows, and are ordered newest first by creation time, with ID as the tie-breaker.

Query parameters

string
Case-insensitive SQL-pattern match. Use %PrimeVault% to match names containing PrimeVault, or PrimeVault% for a prefix. % matches any sequence and _ matches one character.
integer
Page size. Default: 20; effective range: 1-100.
string
Opaque cursor returned as nextCursor. Omit it or send an empty value for the first page.

Response

Returns a page of SubOrg objects. See Cursor response.
SubOrg[]
Sub-orgs on this page. Each item is a SubOrg.
string | null
Cursor for the next page. null on the last page.
boolean
Whether another page exists.
Request example
Response example
When hasNext is true, pass nextCursor unchanged into the next request. Keep the same name filter and page size while paging. An empty result is results: [], nextCursor: null, and hasNext: false. This response does not include a total count.