Docs

List Child Organizations

See your company's child organizations. Send a child's id in X-Company-Id to call any other v2 endpoint on it with this key. The key and its creator need child_company:access.

GET

Headers

Optional headers
string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. Here a key acts in another organization only as one of its members: with "Use this key across all of your organizations" on, in an organization its creator belongs to with a role. Child organizations and MindCloud staff access do not reach this endpoint. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Query

FiltersNarrow list results with a provider-supported where expression. Learn more
string

RSQL expression used to filter list results.

PaginationRequest a specific window of rows with limit and offset. Learn more
number

Maximum number of rows to return.

number

Number of rows to skip.

SortingChoose the order of returned rows when this action supports sorting. Learn more
string

Comma-separated sort fields; prefix with - for descending.

Field selectionChoose which fields should be included in the response. Learn more
string

Comma-separated response fields to include.

Response fields

idstring

The child organization's id. Send it in X-Company-Id to call other endpoints on the child.

namestring

The child organization's name.

descriptionstring

The child organization's description.

originstring

created when your company created it through the API, linked when an existing organization accepted your company as its parent in Cirra.

  • created
  • linked
linkedOndate

When the link started.

memberCountnumber

Members of the child organization, including pending invites.

ownerCountnumber

Active Owners. A child cannot be released while this is 0.