Skip to main content
POST
/
core.v1.PoliciesService
/
GetPolicy
cURL
curl -X POST "https://api.joinformal.com/core.v1.PoliciesService/GetPolicy" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "policy": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "code": "<string>",
    "ast": "<string>",
    "notification": "none",
    "owners": [
      {
        "group": {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "dsyncGroupId": "<string>",
          "terminationProtection": true,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      }
    ],
    "status": "draft",
    "terminationProtection": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "version": 123
  }
}

Authorizations

X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal console.

Body

application/json
id
string
Minimum string length: 1

Response

Success

policy
policy · object