curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_policy \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "organizationId": "<string>",
    "policyId": "<string>"
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UNKNOWN_V1",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "policy": {
        "policyId": "<string>",
        "policyName": "<string>",
        "effect": "<EFFECT_ALLOW>",
        "createdAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "updatedAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "notes": "<string>",
        "consensus": "<string>",
        "condition": "<string>"
      }
    }
  }
}
POST
/
public
/
v1
/
query
/
get_policy

Authorizations

X-Stamp
string
header
required

Body

​
organizationId
string
required

Unique identifier for a given Organization.

​
policyId
string
required

Unique identifier for a given Policy.

Response

A successful response returns the following fields:

​
policy
object
required

policy field

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_policy \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "organizationId": "<string>",
    "policyId": "<string>"
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UNKNOWN_V1",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "policy": {
        "policyId": "<string>",
        "policyName": "<string>",
        "effect": "<EFFECT_ALLOW>",
        "createdAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "updatedAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "notes": "<string>",
        "consensus": "<string>",
        "condition": "<string>"
      }
    }
  }
}