List instructions

get

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

Returns a paginated list of all instructions across the organization, with optional filters. Scope to a policy, claim, or module by passing the corresponding query filter.

Permission: instructions:read (plus instructions:read_hidden to see hidden instructions).

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.

status

array of objects

Filter by one or more statuses.

status

Allowed:

policy_id

uuid

Filter by policy.

claim_id

uuid

Filter by claim.

module_type

string

enum

Filter by module type.

Allowed:

module_id

uuid

Filter by module (e.g. product module).

product_module_id

uuid

deprecated

Deprecated alias for module_id; ignored when module_id is supplied.

function_name

string

Filter by exact function name.

manually_executable

boolean

Filter by manual-executability flag.

execution_datetime_from

date-time

Inclusive lower bound on execution_datetime (ISO 8601, UTC if no offset supplied).

execution_datetime_to

date-time

Inclusive upper bound on execution_datetime (ISO 8601, UTC if no offset supplied).

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