Skip to main content
POST
/
public
/
v1
/
query
/
list_verified_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 ‘EMAIL’, ‘PHONE_NUMBER’.
​
filterValue
string
The value of the filter to apply for the specified type. For example, a specific email or phone number 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_verified_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>"
    }
}'

import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().listVerifiedSuborgs({
  organizationId: "<string> (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 'EMAIL', 'PHONE_NUMBER'.)",
  filterValue: "<string> (The value of the filter to apply for the specified type. For example, a specific email or phone number string.)",
  paginationOptions: { // paginationOptions field,
    limit: "<string> (A limit of the number of object to be returned, between 1 and 100. Defaults to 10.)",
    before: "<string> (A pagination cursor. This is an object ID that enables you to fetch all objects before this ID.)",
    after: "<string> (A pagination cursor. This is an object ID that enables you to fetch all objects after this ID.)",
  }
});

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