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

{
  "organizationIds": [
    "<string>"
  ]
}
POST
/
public
/
v1
/
query
/
list_suborgs

Authorizations

​
X-Stamp
string
required
Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

Body

​
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

paginationOptions field

Response

A successful response returns the following fields:
​
organizationIds
array
required
List of unique identifiers for the matching sub-organizations.
curl --request POST \
  --url https://api.turnkey.com/public/v1/query/list_suborgs \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "filterType": "<string>",
    "filterValue": "<string>",
    "paginationOptions": {
        "limit": "<string>",
        "before": "<string>",
        "after": "<string>"
    }
}'

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