List all tasks

get

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

Query Params

task_type

array of strings

Filter by task type. Can be a comma-separated list.

task_type

Allowed:

task_status

array of strings

Filter by status key. Can be a comma-separated list. Accepts any configured status key, including cancelled.

task_status

task_priority

array of strings

Filter by priority key. Can be a comma-separated list.

task_priority

string

Search tasks by task number, name or other fields.

assigned_to_user_id

uuid

Filter by the user the task is assigned to.

assigned_to_group_id

uuid

Filter by the user group the task is assigned to.

assigned_to_me

boolean

When true, only return tasks assigned to the calling user.

assigned_to_me_or_my_group

boolean

When true, only return tasks assigned to the calling user or to one of their user groups.

is_unassigned

boolean

When true, only return tasks that are not assigned to a user.

is_overdue

boolean

When true, only return open tasks whose due_date is in the past.

is_open

boolean

When true, only return tasks that are not in a terminal (done or cancelled) status.

due_date_before

date-time

Only return tasks due before this date and time.

due_date_after

date-time

Only return tasks due after this date and time.

reference_type

string

enum

Filter by the type of linked entity.

Allowed:

reference_id

string

Filter by the identifier of the linked entity.

schedule_id

uuid

Filter by the task schedule that generated the task.

created_by

uuid

Filter by the identifier of the actor that created the task.

created_by_type

array of strings

Filter by the type of actor that created the task (for example user, product_module, system). Can be a comma-separated list.

created_by_type

sort

string

Sort the results. Supported fields are due_date and created_at. Prefix with - for descending order (for example -created_at).

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.

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