Skip to main content
GET
/
v1
/
policies
/
{policyId}
Get policy
curl --request GET \
  --url https://api.ledger.so/v1/policies/{policyId} \
  --header 'Api-Key: <api-key>'
{
  "object": "policy",
  "id": "<string>",
  "name": "<string>",
  "createdAt": 123,
  "updatedAt": 123,
  "description": "<string>",
  "timeRestrictions": {
    "ttlMinutes": 123,
    "onExpiry": "freeze",
    "activeHoursStart": 11,
    "activeHoursEnd": 11,
    "activeTimezone": "<string>",
    "activeDays": [
      3
    ]
  },
  "spendingRestrictions": {
    "maxAmount": 123,
    "cumulativeMax": 123,
    "maxAuthCount": 123,
    "cooldownMinutes": 123,
    "limitPerAuth": 123,
    "limitPerDay": 123,
    "limitPerMonth": 123
  },
  "merchantRestrictions": {
    "allowedMccs": [
      "<string>"
    ],
    "blockedMccs": [
      "<string>"
    ],
    "merchantHint": "<string>",
    "onDrift": "freeze"
  },
  "attestation": {
    "requireAttestation": true,
    "intentTolerance": 0.5,
    "credentialExposure": "never"
  }
}

Authorizations

Api-Key
string
header
required

API key for authentication. Get your key from the Dashboard.

Path Parameters

policyId
string
required

The policy ID

Response

Policy details

object
enum<string>
required
Available options:
policy
id
string
required
name
string
required

Unique name for this policy within the organization

createdAt
integer
required
updatedAt
integer
required
description
string
timeRestrictions
object
spendingRestrictions
object
merchantRestrictions
object
attestation
object