Skip to main content
Use this route to retrieve policies from a company for lookups, matching, and enrichment in downstream flows.
Scope: paths and request format. Response examples and full schemas can be added later.

​
Endpoints

  • POST /api/companies/{company_id}/policies/list

​
Authentication and headers

Send an API key and JSON payload. 
Authorization: ApiKey <YOUR_API_KEY>
Content-Type: application/json
Accept: application/json

​
List policies

Return a paginated set of policies with optional filters and sorting.

​
Request body shape

{
  "filters": {
    "policyNumber": "<optional-policy-number>",
    "insuredId": "<optional-internal-insured-id>",
    "effectiveDateFrom": "<optional-ISO-date>",
    "effectiveDateTo": "<optional-ISO-date>",
    "status": "<optional-status>",
    "coverageType": "<optional-coverage-type>"
  },
  "pagination": {
    "page": 1,
    "limit": 50
  },
  "sort": {
    "field": "updatedAt",
    "direction": "desc"
  }
}
All fields are optional and can be combined.

​
Example: list by policy number

curl -X POST   "$BASE_URL/api/companies/$COMPANY_ID/policies/list"   -H "Authorization: ApiKey $API_KEY"   -H "Content-Type: application/json"   -d '{
    "filters": { "policyNumber": "POL-123456" },
    "pagination": { "page": 1, "limit": 25 }
  }'

​
Example: list by insured and date range

curl -X POST   "$BASE_URL/api/companies/$COMPANY_ID/policies/list"   -H "Authorization: ApiKey $API_KEY"   -H "Content-Type: application/json"   -d '{
    "filters": {
      "insuredId": "ins_9c8f2a",
      "effectiveDateFrom": "2024-01-01",
      "effectiveDateTo": "2024-12-31"
    },
    "pagination": { "page": 1, "limit": 50 },
    "sort": { "field": "updatedAt", "direction": "desc" }
  }'

​
Parameters

  • company_id is a required path parameter.
  • page and limit control pagination.
  • Use sort.field and sort.direction to control ordering.

​
Notes

  • The endpoint is optimized for search, matching, and enrichment. It may return summary level fields to keep responses fast.
  • Combine filters to narrow results before paging through large sets.