Get Suborgs

Get all suborg IDs associated given a parent org ID and an optional filter.

POST /public/v1/query/list_suborgs

Get Suborgs

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/list_suborgs \
  --header 'Content-Type: application/json' \
  --header 'X-Stamp: <api-key>' \
  --data '
{
  "organizationId": "<string>",
  "filterType": "<string>",
  "filterValue": "<string>",
  "paginationOptions": {
    "limit": "<string>",
    "before": "<string>",
    "after": "<string>"
  }
}
'

200

{
  "organizationIds": [
    "<string>"
  ]
}

Authorizations

ApiKeyAuthAuthenticatorAuth

X-Stamp · string · header · required

Body

application/json

organizationId · string · required

Unique identifier for the parent Organization. This is used to find sub-organizations within it.

filterType · string

Specifies the type of filter to apply, i.e 'CREDENTIAL_ID', 'NAME', 'USERNAME', 'EMAIL', 'PHONE_NUMBER', 'OIDC_TOKEN' or 'PUBLIC_KEY'

filterValue · string

The value of the filter to apply for the specified type. For example, a specific email or name string.

paginationOptions · object

Show child attributes

Response

200 - application/json

A successful response.

organizationIds · string[] · required

List of unique identifiers for the matching sub-organizations.