OpenAPI 3.1.02026-08-1922356291.7 KB

2fbfe2df0cf8

Policy

Policy List

Return the bound policies of an agency, most recently updated first.

Quotes are not included — use the Quote List endpoint for those. Each entry carries the policy_id to retrieve the full policy with. When more policies are available, next_url holds the path of the next page; keep following it until it is no longer returned.

get/v1/agency/policy

Query parameters

limitinteger

Number of policies to return per page

Number of policies to return per page

starting_afterstring nullable

Return the policies that follow this cursor. Take it from next_url rather than building it.

Return the policies that follow this cursor. Take it from next_url rather than building it.

term_start_date_gtestring date nullable

Only return policies whose term starts on or after this date.

Only return policies whose term starts on or after this date.

term_start_date_ltestring date nullable

Only return policies whose term starts on or before this date.

Only return policies whose term starts on or before this date.

producing_agent_emailstring nullable

Only return policies produced by this agent.

Only return policies produced by this agent.

Response

Successful Response

limitinteger required
next_urlstring nullable

Example response

{
  "policies": [
    {
      "policy_id": "pol_831e75ff-5b8c-41af-86d0-771867caaba3",
      "public_policy_id": "FP3-TX-31972630-01",
      "status": "issued",
      "term_start_date": "2025-01-01",
      "expiration_date": "2026-01-01",
      "primary_insured_name": "John Doe",
      "property_addresses": [
        "2376 Fullerton Ave, Austin, TX"
      ],
      "producing_agent_email": "agent@agency.com",
      "updated_at": "2025-01-02T00:00:00Z"
    },
    {
      "policy_id": "pol_0f4d3f6c-9c1a-4f27-9a2b-3d51c0f8b1aa",
      "public_policy_id": "FP3-TX-31972631-00",
      "status": "cancelled",
      "term_start_date": "2024-06-15",
      "expiration_date": "2025-06-15",
      "primary_insured_name": "Acme Rentals LLC",
      "property_addresses": [
        "100 Congress Ave, Austin, TX"
      ],
      "producing_agent_email": "agent@agency.com",
      "updated_at": "2024-11-30T00:00:00Z"
    }
  ]
}