Skip to main content
GET
List tasks in a space

Authorizations

Authorization
string
header
required

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

Path Parameters

space_id
string
required

Query Parameters

archived
boolean
scheduled
enum<string>

true lists only scheduled tasks; absent or false only unscheduled ones; any both.

Available options:
true,
false,
any
limit
integer
default:300

How many results to return at most, up to 999. has_more tells you whether another page exists.

offset
integer
default:0

If there are more results than the limit, offset can be used to get to the next batch of results

sort_by
string
default:created_at

Name of the field used for sorting, such as created_at, updated_at or activity_at.

sort_order
enum<string>
default:asc

Should the results be sorted in ascending or descending order relative to sort_by field

Available options:
asc,
desc
created_by
string

Exact match on the user ID of the task creator

priority
string

Exact match on priority; comma-separated values to filter by priority

status
string

Exact match on status; comma-separated values to filter by multiple statuses. See with_no_status.

title
string

Term search on task title

assignees
string

Comma-separated assignee IDs; at least one must match

reporter
string
created_at
string

Filter by creation date. Use a single date or a range as {start_date},{end_date}

updated_at
string

Filter by last-updated date. Use a single date or a range as {start_date},{end_date}

scheduled_at
string

Filter by scheduled date. Use a single date or a range as {start_date},{end_date}

external_id
string

Exact match.

folder
string

Exact folder (every task for one base record).

tags
string

Comma-separated; at least one must match.

parent
string

Parent task id, to list subtasks; comma-separated to list several parents' subtasks.

source
string

Exact source.

currency
string

Exact currency.

due_date
string

Due date filter.

exclude_subtasks
string

true drops subtasks from the page after it is read; each parent still nests subtasks on the same page. Prefer parents_only, which pages and counts parents only.

parents_only
string

true pages top-level tasks only, so total_hits counts parents; each parent carries all its subtasks in subtasks.

nest_subtasks
string

true gives every listed parent all its subtasks in subtasks, while subtasks are still listed as rows of their own.

with_no_status
string

true adds tasks with no status to the status filter; on its own, lists only tasks with no status.

q
string

Search: any word of the title or description, the last word as a prefix, or a task id prefix (OPS-12 finds OPS-120 to OPS-129).

ids
string

Comma-separated task ids, read by key.

folders
string

Comma-separated folders, each matched exactly.

under_folder
string

A folder and every folder nested in it, absolute (spaces.<id>.a) or space-relative (a).

dated
enum<string>

true lists tasks with a due date or scheduled time, false those with neither.

Available options:
true,
false
counts
enum<string>

status adds counts.status: the number of matching tasks per status, "" for tasks with no status. A failed count leaves counts out rather than failing the page.

Available options:
status
count_due
string

With counts=status, a start,end date range; adds counts.due, how many matching tasks are due in it.

Response

List of tasks

results
object[]
results_total
integer

Number of results on this page. It is not a total across pages.

has_more
boolean

True when another page exists. Left out when false.

total_hits
integer

Every match across all pages, as the index counts them.

counts
object

Present when counts=status was asked for and could be read.