Approval request details

An approval request with approvers (profile cards), its full event history (audit), and the initiator. Visible to the initiator / approver / admin.

curl -X GET "https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/approval-requests/example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests
import json

url = "https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/approval-requests/example_string"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch("https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/approval-requests/example_string", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/approval-requests/example_string", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/approval-requests/example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

response = http.request(request)
puts response.body

{
  "id": "cmr3f41z20001psp7phmyapw3",
  "vaultId": "example_string",
  "action": "example_string",
  "status": "example_string",
  "initiatorId": "example_string",
  "targetType": "example_string",
  "targetId": "example_string",
  "baseVersion": "example_string",
  "payload": "null",
  "decisionPolicyId": "example_string",
  "decisionPolicyCode": "example_string",
  "approvalThreshold": 42,
  "resolvedResultId": "example_string",
  "resolvedAt": "2026-07-02T11:25:15.134000Z",
  "createdAt": "2026-07-02T11:25:15.134000Z",
  "updatedAt": "2026-07-02T11:25:15.134000Z",
  "approvers": [
    {
      "id": "example_string",
      "userId": "example_string",
      "decision": "approve",
      "comment": "example_string",
      "votedAt": "2026-07-02T11:25:15.134000Z",
      "stepIndexesJson": [
        42
      ],
      "createdAt": "2026-07-02T11:25:15.134000Z",
      "user": {
        "id": "example_string",
        "name": "John Doe",
        "email": "user@example.com",
        "username": "John Doe",
        "image": "example_string",
        "color": "#000",
        "emoji": "🦊"
      }
    }
  ],
  "events": [
    {
      "id": "example_string",
      "type": "example_string",
      "actorId": "example_string",
      "decision": "example_string",
      "comment": "example_string",
      "createdAt": "2026-07-02T11:25:15.134000Z"
    }
  ],
  "initiator": {
    "id": "example_string",
    "name": "John Doe",
    "email": "user@example.com",
    "username": "John Doe",
    "image": "example_string",
    "color": "#000",
    "emoji": "🦊"
  },
  "steps": [
    {
      "stepIndex": 42,
      "action": "example_string",
      "payload": "null",
      "targetType": "example_string",
      "targetId": "example_string",
      "approvalThreshold": 42,
      "approvals": 42,
      "satisfied": true,
      "resolvedResultId": "example_string",
      "appliedAt": "2026-07-02T11:25:15.134000Z"
    }
  ]
}

GET

/api/v1/vaults/{code}/approval-requests/{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.

API Key (cookie: session_token)

session_tokenstring

Required

API key (sent in cookie)

path

codestring

Required

Unique Vault code (slug)

path

idstring

Required

Approval request 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

codestring

Required

Unique Vault code (slug)

Example:

demo_vault

idstring

Required

Approval request id (cuid)

Responses

idstring

Required

cuid

vaultIdstring

Required

actionstring

Required

statusstring

Required

PENDING|APPROVED|REJECTED|CANCELLED

initiatorIdstring

Required

targetTypestring

Required

targetIdstring

Required

baseVersionstring

Required

payloadstring

Required

decisionPolicyIdstring

Required

decisionPolicyCodestring

Required

approvalThresholdinteger

Required

resolvedResultIdstring

Required

resolvedAtstring

Required

createdAtstring

Required

updatedAtstring

Required

approversarray

Required

eventsarray

Required

initiatorstring

Required

stepsarray

Required

Steps of a composite request (empty for a single action)

Was this page helpful?