v1
latestOpenAPI 3.0.12026-07-2491247233.8 KBList child organizations
List the child organizations under the calling organization, including license and usage data.
Query parameters
Filter by active status. true returns only active organizations; false returns only soft-deleted or scheduled-for-deletion organizations; omit to return all.
Filter by active status. true returns only active organizations; false returns only soft-deleted or scheduled-for-deletion organizations; omit to return all.
Maximum number of organizations to return. Capped at 500.
Maximum number of organizations to return. Capped at 500.
How deep to descend: 1 (the default) returns direct children only, 2 includes grandchildren, and so on. Capped at the maximum hierarchy depth.
How deep to descend: 1 (the default) returns direct children only, 2 includes grandchildren, and so on. Capped at the maximum hierarchy depth.
Zero-based offset into the result set, used for pagination.
Zero-based offset into the result set, used for pagination.
Restrict results to descendants of this organization. Must be the calling organization itself or one of its descendants. Defaults to the calling organization.
Restrict results to descendants of this organization. Must be the calling organization itself or one of its descendants. Defaults to the calling organization.
Optional case-insensitive substring filter on organization name. Partial matches are returned.
Optional case-insensitive substring filter on organization name. Partial matches are returned.
Response
OK
Example response
{
"total": 3
}