Skip to main content
GET
List the member's tasks

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company.

Headers

If-None-Match
string

ETag from a previous response.

Query Parameters

filter[status]
enum<string>
default:active

active (the default), completed or all.

Available options:
active,
completed,
all
filter[due]
enum<string>

Due window in the member's time zone: overdue (incomplete and past due), today, week (today and the next six days) or none (no due time).

Available options:
overdue,
today,
week,
none
filter[contact_id]
string<uuid>

Only tasks about this contact. A contact that is not the member's matches nothing.

sort
enum<string>

due_at (soonest first, no due time last; the default for active and all), created_at, -created_at or -completed_at (the default for completed).

Available options:
due_at,
created_at,
-created_at,
-completed_at
page[cursor]
string

Opaque cursor from meta.pagination.next_cursor. A cursor issued for other filters, another sort or another member restarts at the first page; a malformed, tampered or expired one (older than three days) returns 400.

page[limit]
integer
default:25

Page size. Defaults to 25, at most 100.

Required range: 1 <= x <= 100

Response

One page of tasks.

One page of tasks.

status
integer
required
data
object[]
required
meta
object
required

Envelope metadata present on every response.