List all policies

get

https://sandbox.uk.rootplatform.com/v1/insurance/policies

Query Params

page_size

integer

1 to 100

Defaults to 30

The maximum number of items that will be contained in a single page, between 1 and 100 (inclusive).

page

integer

≥ 1

Defaults to 1

The page number of the entities to fetch. Must be a minimum of 1.

string

A general-purpose parameter used to search for policies across policy.policy_number, policy.package_name, policyholder.first_name, policyholder.last_name, policyholder.company_name, policyholder.identification_number, policyholder.registration_number, policyholder.cellphone, policyholder.phone_other,
and policyholder.email.

status

string

A comma separated list of policy statuses to filter by.

policyholder_id

string

Must be a UUID. Filter for policies linked to this policyholder.

created_by

string

Must be a UUID. The unique identifier of the agent that created the policy.

user_group_id

string

Must be a UUID. Filter for policies assigned to this user group. When the request is authenticated with a user-group-segmented API key, results are always restricted to that key's own group and this parameter is ignored.

include

array of strings, unique

Whether to include the full policyholder object linked to the policy in the response.

product_module_id

string

Must be a UUID. Filter for policies issued under this product module.

policy_number

array of strings, unique

List of case sensitive policy numbers to filter by.

policy_number

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success