Sub-Orgs
List Sub-Orgs
Retrieve a paginated list of sub-orgs, optionally filtered by name.
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
Case-insensitive SQL-pattern match. Use
%PrimeVault% to match names containing PrimeVault, or PrimeVault% for a prefix. % matches any sequence and _ matches one character.Response
Returns a page of SubOrg objects. See Cursor response.Sub-orgs on this page. Each item is a SubOrg.
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.