List child organizations

get

{scheme}://{server}/v0/organizations/mine/child-organizations

List the child organizations under the calling organization, including license and usage data.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

active

boolean | null

Filter by active status. true returns only active organizations; false returns only soft-deleted or scheduled-for-deletion organizations; omit to return all.

limit

int32 | null

≤ 500

Maximum number of organizations to return. Capped at 500.

max_depth

int32 | null

≥ 1

How deep to descend: 1 (the default) returns direct children only, 2 includes grandchildren, and so on. Capped at the maximum hierarchy depth.

offset

int32 | null

Zero-based offset into the result set, used for pagination.

parent_org_id

uuid | null

Restrict results to descendants of this organization. Must be the calling organization itself or one of its descendants. Defaults to the calling organization.

string | null

Optional case-insensitive substring filter on organization name. Partial matches are returned.

Response

200OK