List tasks

get

https://platform.homecarepro.io/api/tasks

Lists tasks. Filter by member to show one new hire's checklist and the status of each item.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 1

Defaults to 1

The page to return, starting at 1. Pages hold up to 100 records.

filters[agency_member][id][]

array of objects

Return only records belonging to one of these agency members.

filters[agency_member][id][]

filters[task_assignment][status][]

array of objects

Return only tasks with one of these statuses.

filters[task_assignment][status][]

Allowed:

includes[]

array of strings

Embed related records in the response, for example includes[]=agency_member. An unsupported value returns 422.

includes[]

Allowed:

Headers

X-Agency-Id

uuid

required

The agency the request is for. It must be an agency associated with your connected system. A request without it returns 400; an agency that isn't associated with your connected system returns 404.

Responses

Language

Credentials

Bearer

Loading…

Response

Choose an example:

application/json

200A page of tasks.

400The request has no X-Agency-Id header.

401The access token is missing, invalid or expired.

404The record doesn't exist, or belongs to an agency that isn't associated with your connected system.

422The request was well formed but its values were invalid.