---
title: "List child organizations"
method: GET
path: "/v0/organizations/mine/child-organizations"
tags: ["Organizations"]
---

# List child organizations

`GET /v0/organizations/mine/child-organizations`

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

## Query parameters

- `active` boolean, nullable — Filter by active status. true returns only active organizations; false returns only soft-deleted or scheduled-for-deletion organizations; omit to return all.
- `limit` integer, nullable — Maximum number of organizations to return. Capped at 500.
- `max_depth` integer, nullable — How deep to descend: 1 (the default) returns direct children only, 2 includes grandchildren, and so on. Capped at the maximum hierarchy depth.
- `offset` integer, nullable — Zero-based offset into the result set, used for pagination.
- `parent_org_id` string, uuid, nullable — Restrict results to descendants of this organization. Must be the calling organization itself or one of its descendants. Defaults to the calling organization.
- `search` string, nullable — Optional case-insensitive substring filter on organization name. Partial matches are returned.

## Response `200`

OK

- HandlerTypesListChildOrganizationsResponse
  - `children` TypesOrganization[] — The matching child organizations, ordered by name.
    - `active_automation_rule_count` integer — Number of active automation rules
    - `active_detection_rule_count` integer — Number of active detection rules
    - `active_mailbox_count` integer — Number of currently active mailboxes
    - `can_add_children` boolean, nullable — Whether this organization can add child organizations
    - `can_manage_child_licenses` boolean, nullable — Whether this organization can manage child organization licenses
    - `created_at` string, date-time — Time at which the organization was created
    - `deleted_at` string, date-time, nullable — Time at which org was soft deleted (inaccessible, data not deleted)
    - `id` string — Organization unique ID
    - `licenses` TypesLicense[] — Active licenses for this organization
      - `sku` 'sublime_email_security' — Identifies the licensed product. "sublime_email_security" is the only SKU available today.
      - `status` 'trialing' | 'active' | 'no_subscription' | 'past_due' | 'canceled' | 'unpaid' | 'incomplete' | 'incomplete_expired' — Current billing status of this license. This reflects the underlying billing state and may differ from a requested transition target. Common values: "trialing" (within a time-limited trial — see trial_expires_at for the end date), "active" (a paid, current subscription), and "no_subscription" (free tier — no active subscription). Stripe-derived states such as "past_due", "canceled", "unpaid", "incomplete", and "incomplete_expired" may also appear.
      - `trial_expires_at` string, date-time, nullable — When the trial period ends. Present only while status is "trialing"; omitted otherwise.
    - `name` string — Organization chosen name
    - `parent_org_id` string, nullable — ID of this organization's parent in the hierarchy. The top-level organization has no parent.
    - `scheduled_for_deletion_at` string, date-time, nullable — Time at which hard deletion of org data is scheduled to begin
    - `total_mailbox_count` integer — Total number of mailboxes
  - `total` integer — Total number of matching child organizations, ignoring offset/limit.

---

[API](https://skmtc.net/sublime/apis/sublime-platform-api.md) · [All operations](https://skmtc.net/sublime/apis/sublime-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sublime/sublime-platform-api/revisions/d5df82850357/schema)