Skip to main content
GET
List the tickets sent to an agency

Authorizations

Authorization
string
header
required

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

Path Parameters

agency
string
required

The agency key, as a root admin created it.

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

Query Parameters

sort
enum<string>

updated (the default) and board both return the most recently updated tickets first: board positions belong to one company, so they order nothing across companies. due returns tickets by due date, earliest first, then tickets 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. 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 tickets with no priority.

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 tickets with no kind. Values within the filter match any of them; the filter narrows with the other filters, and with filter[category] a ticket 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 tickets, support keeps support tickets and eng keeps bugs, changes and features. none keeps tickets 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] a ticket must match both.

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

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

Required string length: 1 - 255
filter[owner]
enum<string>

me keeps tickets the caller owns. unpicked keeps tickets nobody owns: never picked up, or released.

Available options:
me,
unpicked
filter[stage]
string

Comma-separated request stages to keep, for example requested,quoted: requested waits for a quote, quoted waits for the customer, accepted is being built and done_proposed waits for the customer to accept the work. meta.total counts with the filter.

Maximum string length: 200
Pattern: ^(requested|quoted|accepted|done_proposed)( *, *(requested|quoted|accepted|done_proposed))*$
filter[due_from]
string<date>

Keep tickets due on or after this date, an inclusive calendar date the client computes in its own time zone. Tickets 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 tickets due on or before this date, an inclusive calendar date the client computes in its own time zone. Tickets 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 tickets with no due date. Refused with filter[due_from] or filter[due_to].

Available options:
none

Response

A page of the agency's tickets.

tasks
object[]
required
status
any
required
meta
object
required