Skip to main content
The Policies API allows you to retrieve policy information for your company. Policies represent the insurance contracts that have been issued. Key Concepts:
  • Policies are insurance contracts issued to insureds
  • Each policy has a number, primary insured, and effective dates
  • Policies can be filtered by primary insured and searched by text
  • Results are paginated with a fixed page size of 50

​
API Endpoints

  • List Policies - Retrieve paginated list of policies with filtering and sorting

​
Policy Fields

FieldTypeDescription
iduuidPolicy identifier
companyIduuidCompany identifier
numberstringPolicy number
createdAtdatetimeWhen the policy was created (ISO 8601)
primaryInsuredIduuid/nullID of the primary insured on this policy

​
Filtering and Sorting

​
Filter Parameters

ParameterTypeDescription
primaryInsuredIduuidFilter by primary insured ID
filterTextstringText search across policy number and other fields

​
Sorting Parameters

ParameterTypeDefaultDescription
sortBystringcreatedAtField to sort by (createdAt, updatedAt, number, startsAtDate, endsAtDate)
sortDirectionstringdescSort direction (asc or desc)

​
Pagination

ParameterTypeDefaultDescription
pageinteger1Page number (1-based, page size 50)
Response includes:
  • items - Array of policies for the current page
  • totalCount - Total number of matching policies across all pages

​
Permissions

Access to policies requires the appropriate permissions based on your API key:
OperationRequired Permission
List Policiescompany.policy:read

​
Example Response

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440100",
      "companyId": "550e8400-e29b-41d4-a716-446655440000",
      "number": "POL-2025-001",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "primaryInsuredId": "550e8400-e29b-41d4-a716-446655440200"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440101",
      "companyId": "550e8400-e29b-41d4-a716-446655440000",
      "number": "POL-2025-002",
      "createdAt": "2025-01-16T14:20:00.000Z",
      "primaryInsuredId": "550e8400-e29b-41d4-a716-446655440201"
    }
  ],
  "totalCount": 42
}