PoliciesPolicy details

Policy details

A policy with all its rules and selectors, owner group, and approver group.

curl -X GET "https://policy-engine-rest.ezig.workers.dev/api/v1/policies/example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "id": "cmr3f41z20001psp7phmyapw3",
  "groupId": "example_string",
  "code": "allow-small",
  "name": "John Doe",
  "description": "example_string",
  "logoUri": "example_string",
  "color": "#0A84FF",
  "emoji": "🛡️",
  "actionType": "transfer",
  "effect": "allow",
  "blockReason": "example_string",
  "approvalThreshold": 42,
  "adminBypass": true,
  "allowInitiatorApproval": true,
  "enabled": true,
  "createdAt": "2026-07-02T11:25:15.134000Z",
  "updatedAt": "2026-07-02T11:25:15.134000Z",
  "rules": [
    {
      "id": "cmr3f41z20001psp7phmyapw3",
      "policyId": "example_string",
      "conditionType": "require",
      "createdAt": "2026-07-02T11:25:15.134000Z",
      "selectors": [
        {
          "id": "cmr3f41z20001psp7phmyapw3",
          "ruleId": "example_string",
          "selectorType": "amount",
          "value": "null"
        }
      ]
    }
  ],
  "approvers": [
    {
      "id": "example_string",
      "kind": "user",
      "userId": "admin-1",
      "groupId": "example_string",
      "createdAt": "2026-07-02T11:25:15.134000Z"
    }
  ],
  "group": {
    "id": "example_string",
    "code": "traders",
    "name": "John Doe",
    "vaultId": "example_string"
  }
}
GET
/api/v1/policies/{id}
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Session token. Mobile/services. The web uses a cookie.

Session token. Mobile/services. The web uses a cookie.
API Key (cookie: session_token)
session_tokenstring
Required

API key (sent in cookie)

path
idstring
Required

Policy id (cuid)

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Session token. Mobile/services. The web uses a cookie.

path
parameterstring
Required

API Key for authentication. Provide your API key in the cookie.

Path Parameters

idstring
Required

Policy id (cuid)

Responses

idstring
Required

cuid

groupIdstring
Required
codestring
Required
namestring
Required
descriptionstring
Required
logoUristring
Required
colorstring
Required
emojistring
Required
actionTypestring
Required
effectstring
Required
blockReasonstring
Required
approvalThresholdstring
Required
adminBypassboolean
Required
allowInitiatorApprovalboolean
Required
enabledboolean
Required
createdAtstring
Required
updatedAtstring
Required
rulesarray
Required
approversarray
Required

Explicit approvers (for an allow policy with approval{})

groupobject
Required