Skip to main content
POST
/
core.v1.PoliciesService
/
ListPolicyReports
cURL
curl -X POST "https://api.joinformal.com/core.v1.PoliciesService/ListPolicyReports" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "reports": [
    {
      "id": "<string>",
      "policyCode": "<string>",
      "evaluationStart": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "policyId": "<string>",
      "createdBy": "<string>",
      "status": "<string>"
    }
  ],
  "listMetadata": {
    "after": "<string>",
    "before": "<string>",
    "count": 123,
    "nextCursor": "<string>"
  }
}

Authorizations

X-API-KEY
string
header
required

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

Body

application/json
limit
integer<int32>
Required range: x <= 500
cursor
string
order
string
policyId
string | null
Minimum string length: 1

Response

Success

reports
PolicyReport · object[]
listMetadata
list_metadata · object