List all claims

get

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

Returns a paginated list of claims for the organization. Use the query parameters to filter claims by status, policy, policyholder, and more. Use the include parameter to include related objects in the response.

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.

claim_status

array of strings

Filter by claim status. Accepts multiple values.

claim_status

approval_status

array of strings

Filter by approval status. Accepts multiple values.

approval_status

string

Search claims by claim number, claimant name, or other searchable fields.

policyholder_id

string

Must be a UUID. Filter claims by policyholder ID.

product_module_id

string

Must be a UUID. Filter claims by product module ID.

policy_id

string

Must be a UUID. Filter claims by policy ID.

created_by

string

Must be a UUID. Filter claims by the ID of the user or API key that created them.

created_by_type

string

enum

Filter claims by the type of entity that created them.

Allowed:

assigned_to

string

Must be a UUID. Filter claims by the user they are assigned to.

user_group_id

string

Must be a UUID. Filter claims by user group ID.

include

array of strings

A comma-separated list of related objects to include in the response. Valid values: policy, policyholder, user_group.

include

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