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

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.
​
activityId
string
required
Unique identifier for a given activity.

Response

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

{
  "policyEvaluations": [
    {
      "id": "<string>",
      "activityId": "<string>",
      "organizationId": "<string>",
      "voteId": "<string>",
      "policyEvaluations": [
        {
          "policyId": "<string>",
          "outcome": "<OUTCOME_ALLOW>"
        }
      ],
      "createdAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      }
    }
  ]
}