List child organizations

List all child organizations under the specified parent organization.

Access control

Requires the caller to be an admin in the parent organization (i.e. the one on the path), or any of its ancestors.

Example: Assume an organization hierarchy like: org-a -> org-b -> org-c. To list child organizations under org-b, which means calling 'GET /api/v1/orgs/org-b/orgs', the caller must be an admin in org-a or org-b.

Securityorg-oidc-token
Request
path Parameters
org
required
string (OrgId) [ 3 .. 64 ] characters ^([a-z][a-z0-9-]{1,62}[a-z0-9])$

ID of an organization

Example: my-org
Responses
200

A list of organizations

get/api/v1/orgs/{org}/orgs
Request samples
Response samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "nextCursor": "string"
}