Skip to main content
GET
List issues

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

id identifier

Query Parameters

status
string
priority
enum<integer>
Available options:
0,
1,
2,
3
projectId
string
assigneeId
string
assignee
string

Compact view filter for view=board or view=list. Accepts a member ID or unassigned, and matches primary plus multi-assignee links.

teamId
string
milestoneId
string
initiativeId
string

Compact view filter for view=board or view=list. Matches issues directly linked to an initiative plus issues in milestones linked to that initiative.

scope
enum<string>

Compact view filter for view=board or view=list.

Available options:
mine,
blocked
q
string

Search issue title and description on full issue lists. With view=board or view=list, searches title and issue number.

view
enum<string>

Use the compact issue payload. Required for assignee, initiativeId, and scope filters.

Available options:
board,
list
open
boolean

When true, exclude terminal statuses done and cancelled plus archived issues. Custom and other non-terminal statuses remain included. Takes precedence over includeArchived.

includeArchived
boolean
orderBy
enum<string>
Available options:
created_at,
updated_at,
priority,
due_date,
title,
status
orderDir
enum<string>
Available options:
asc,
desc
limit
integer
default:25
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
shape
enum<string>

Opt into the CLI-compatible list envelope response.

Available options:
envelope,
cli
response_shape
enum<string>

Alias for shape; use cli for the CLI-compatible list envelope response.

Available options:
cli,
envelope

Response

Successful response

Legacy issue-list response or CLI-compatible envelope. Full issue-list items include identifier and projectSlug; compact board/list items omit both.

issues
object[]
required
total
integer
required
limit
integer
required
offset
integer
required