Skip to main content
POST
/
public
/
v1
/
query
/
list_policies

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 a given organization.

Response

A successful response returns the following fields:
​
policies
array
required
A list of policies.
curl --request POST \
  --url https://api.turnkey.com/public/v1/query/list_policies \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<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().getPolicies({
  organizationId: "<string> (Unique identifier for a given organization.)"
});

{
  "policies": [
    {
      "policyId": "<string>",
      "policyName": "<string>",
      "effect": "<EFFECT_ALLOW>",
      "createdAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      },
      "updatedAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      },
      "notes": "<string>",
      "consensus": "<string>",
      "condition": "<string>"
    }
  ]
}