SUsublime
Organizations

List child organizations

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

get/v0/organizations/mine/child-organizations

Request

  • Base URL
    https://platform.sublime.security
  • URL
    https://platform.sublime.security/v0/organizations/mine/child-organizations
  • Auth
    HTTP bearer

Query parameters

activeboolean nullable

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

Example:true
limitinteger nullable

Maximum number of organizations to return. Capped at 500.

Example:50
max_depthinteger nullable

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

Example:2
offsetinteger nullable

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

parent_org_idstring 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.

Example:019263d1-7c1a-7c8e-9c66-f1c2a9b1f4e2
searchstring nullable

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

Example:acme

Response

OK

totalinteger

Total number of matching child organizations, ignoring offset/limit.

Example response

{
  "total": 3
}

Changes

No recorded changes to this operation across all 1 revision of this API.