STsteadily
Policy

Policy List

Changed on

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

Request

  • Base URL
    https://api.steadily.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.steadily.com/v1/agency/policy
  • Auth
    HTTP bearer

Query parameters

limitinteger

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.

term_start_date_gtestring date nullable

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.

producing_agent_emailstring nullable

Only return policies produced by this agent.

Response

Successful Response

limitinteger required
next_urlstring nullable

Example response

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

Changes

  • 28ec84365d3eRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • f7ade5988cfbRevision changes
    • breaking

      response property next_url list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property policies/items/primary_insured_name list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property policies/items/producing_agent_email list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property policies/items/updated_at list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the // response's property type changed from no type to string for status

    • warning

      added the new cancelled enum value to the // response property for the response status

    • warning

      added the new issued enum value to the // response property for the response status

    • warning

      added the new voided enum value to the // response property for the response status

    • info

      removed from the // response property allOf list for the response status