List all Insurance Policies

Retrieve a list of insurance policies.

Required authorization scope: public.insurance_policy:read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1

Page number to fetch, default: 1

integer
1 to 100

Number of records per page to fetch, default: 20

string
enum

Filter records by policy type. By default, both easyship_label and external_label policies are returned. If easyship_shipment_id or source is set and policy_type is not, only easyship_label policies are returned, since those two filters have no equivalent on external_label policies.

Allowed:
string

Filter records by Easyship shipment ID. Only matches easyship_label policies; if set without policy_type, external_label policies are excluded entirely rather than returned unfiltered.

string
enum

Filter records by insurance state. Applies to both policy types, each using its own state machine's values (see the state field on the response schema) -- easyship_label and external_label policies do not share a vocabulary, so this does not translate state values between them.

string
enum

Filter records by recipient.

Allowed:
string
enum

Filter records by source type. External: shipment label is not generated by Easyship. Cloud: shipment label is generated by Easyship. Efulfilment: Special contract with Easyship. Only matches easyship_label policies; if set without policy_type, external_label policies are excluded entirely rather than returned unfiltered.

Allowed:
Response

Language
Credentials
Bearer
token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json