Policies

Policies are results captured through a policy link. The list includes policies for every team the authenticated user belongs to, most recently created first, up to 20 records.

The policy model

Properties

Name
id
Type
integer
Description
Unique identifier for the policy.
Name
description
Type
string
Description
Summary built from the policy id, policy link name, and client name.
Name
client_id
Type
integer
Description
Client attached to the policy, when one is set.
Name
policyLink
Type
object
Description
The policy link: id, team_id, assigned_to, assigned (id, name, email), created_at, and updated_at.
Name
data
Type
object
Description
Decoded policy payload.
Name
client
Type
object
Description
Client object. See Clients.
Name
riskProfile
Type
object
Description
Related risk profile, including its client and insurances. See Risk profiles.
Name
created_at
Type
timestamp
Description
When the policy was created.
Name
updated_at
Type
timestamp
Description
When the policy was last updated.

GET/api/policies

List policies

Returns up to 20 policies, most recently created first. The order uses created_at, not updated_at.

Optional attributes

Name
event
Type
string
Description
all (default), success, or documents. success keeps successful policy-link events. documents keeps uploaded-document events.
Name
client_id
Type
integer
Description
Only policies for this client id.
Name
client_email
Type
string
Description
Only policies whose client email matches exactly.

Request

GET

/api/policies

curl -G https://app.riskadvisor.insure/api/policies \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -d event=success \
  -d [email protected]

Response

{
  "data": [
    {
      "id": 18,
      "description": "#18 - Canopy Connect - Frank McCallister",
      "client_id": 42,
      "policyLink": {
        "id": 4,
        "team_id": 3,
        "assigned_to": 7
      },
      "data": {},
      "client": {
        "id": 42,
        "full_name": "Frank McCallister",
        "email": "[email protected]"
      },
      "created_at": "2026-09-01T15:00:00.000000Z",
      "updated_at": "2026-09-02T15:00:00.000000Z"
    }
  ]
}