Skip to main content
GET
List the company's work

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

sort
enum<string>

updated (the default) returns the most recently updated work first. board returns work in the order boards draw a column: unplaced work first, then by board_position compared byte by byte, ties by id. due returns work by due date, earliest first, then work with no due date, ties by id.

Available options:
updated,
board,
due
page[cursor]
string

Opaque cursor returned by the previous page.

Maximum string length: 4096
page[limit]
integer

Maximum records to return, defaulting to 25.

Required range: 1 <= x <= 100
filter[status]
string

Comma-separated statuses to keep, for example open,needs_info.

Maximum string length: 200
Pattern: ^(open|kept|needs_info|in_progress|handed|review|skipped)( *, *(open|kept|needs_info|in_progress|handed|review|skipped))*$
filter[exclude_status]
string

Comma-separated statuses to leave out, so a board can read the work whose status it has no column for. Refused together with filter[status].

Maximum string length: 200
Pattern: ^(open|kept|needs_info|in_progress|handed|review|skipped)( *, *(open|kept|needs_info|in_progress|handed|review|skipped))*$
filter[priority]
string

Comma-separated priorities to keep, for example urgent,high. none keeps work with no priority. Values within the filter match any of them; the filter narrows with the other filters.

Maximum string length: 200
Pattern: ^(urgent|high|medium|low|none)( *, *(urgent|high|medium|low|none))*$
filter[kind]
string

Comma-separated kinds to keep, for example bug,change. none keeps work with no kind. Values within the filter match any of them; the filter narrows with the other filters, and with filter[category] work must match both.

Maximum string length: 200
Pattern: ^(bug|change|feature|design|support|none)( *, *(bug|change|feature|design|support|none))*$
filter[category]
string

Comma-separated categories to keep, for example design,support: design keeps design work, support keeps support work and eng keeps bugs, changes and features. none keeps work with no kind, which belongs to no category. Values within the filter match any of them; the filter narrows with the other filters, and with filter[kind] work must match both.

Maximum string length: 200
Pattern: ^(design|support|eng|none)( *, *(design|support|eng|none))*$
filter[assignee]
string

Keep work assigned to nobody (unassigned, which includes work whose assigned user was deleted and so has no assignee), to Mist (agent), or to the person with this user id.

Maximum string length: 20
Pattern: ^(unassigned|agent|[1-9][0-9]{0,18})$
filter[tag]
enum<string>

The retired fluid_studios tag, kept for older clients. No work carries it, so this keeps nothing. Use filter[agency] instead. Any other value answers 422.

Available options:
fluid_studios
filter[without_tag]
enum<string>

The retired fluid_studios tag, kept for older clients. No work carries it, so this leaves the list as it is. Any other value answers 422.

Available options:
fluid_studios
filter[agency]
string

Keep work sent to the agency with this key, any for work sent to an agency, or none for work sent to no agency. A key that names no agency keeps nothing. The filter narrows what the caller may already read and grants no access of its own.

Maximum string length: 64
Pattern: ^[a-z0-9_]+$
filter[title]
string

Keep work whose title contains this text, ignoring case. % and _ match themselves.

Required string length: 1 - 255
filter[due_from]
string<date>

Keep work due on or after this date, an inclusive calendar date the client computes in its own time zone. Work with no due date are not kept. May be combined with filter[due_to]; refused with filter[due], and when it is after filter[due_to].

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
filter[due_to]
string<date>

Keep work due on or before this date, an inclusive calendar date the client computes in its own time zone. Work with no due date are not kept. May be combined with filter[due_from]; refused with filter[due].

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
filter[due]
enum<string>

none keeps work with no due date. Refused with filter[due_from] or filter[due_to].

Available options:
none

Response

A page of company work.

tasks
object[]
required
status
any
required
meta
object
required