List your company's tasks

Your company's tasks, loan-linked and general, earliest due first.

Tasks on archived loans are not listed. When a loan file is
archived its tasks drop out of this list; general tasks are never
affected. Asking for one of them by id answers 409 and names the loan.

Times are in your company's time zone. dueAt and reminderAt
carry an offset, so the moment is exact wherever you read it. The
dueFrom and dueTo filters are calendar days in that same zone.

Order. By dueAt, earliest first, then by id. Tasks with no due
time come last.

Filters combine. Every filter you send narrows the list further.
A parameter this endpoint does not know is ignored and named in
meta.warnings, so a misspelt filter never silently returns the whole
list as if it had been applied.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1

Only the tasks attached to this loan file.

boolean

true for general tasks only (no loan), false for loan tasks only. Leave it out for both.

status
array of objects
length ≤ 10

One or more statuses, comma-separated, e.g. Not Started,In Progress.

status
Allowed:
priority
array of objects
length ≤ 10

One or more priorities, comma-separated.

priority
Allowed:
boolean

true for open tasks whose due time has passed — status Not Started or In Progress, or no status. false for every other task, including tasks with no due time. Leave it out for both.

date

First calendar day, in your company's time zone, a task may be due on.

date

Last calendar day, in your company's time zone, a task may be due on. Not before dueFrom.

string
enum

The kind of person in assigneeId. Send both or neither.

Allowed:
integer
≥ 1

Only tasks currently assigned to this person. A broker id sent with assigneeType=loan-officer matches nothing, and the reverse.

string
enum
Defaults to all

manual for tasks people created, automation for tasks your automated rules created, all for both.

Allowed:
integer
≥ 1

Which page to return, counting from 1. Defaults to page 1.

Leaving this off does not return every row — every list on this API
is paged. See perPage for the size, and read
meta.pagination.perPage back rather than assuming it.

integer
1 to 100

How many rows you want per page, from 1 to 100.

Omitted, it falls back to a server-configured default (25 today).
Read the size actually applied from meta.pagination.perPage rather
than assuming this number — it is configuration, not contract, and it
has already changed once.

The number of rows in data is therefore the size of the PAGE, never
of the list. meta.pagination.total is the size of the whole list, so
a single call with perPage=1 sizes a list before you fetch it, and
hasMore says whether more remain.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json