コンテンツにスキップ
backlog-cli

Get list of issues

GET
/issues

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
projectId[]
Array<integer>
issueTypeId[]
Array<integer>
categoryId[]
Array<integer>
versionId[]
Array<integer>
milestoneId[]
Array<integer>
statusId[]
Array<integer>
priorityId[]
Array<integer>
assigneeId[]
Array<integer>
createdUserId[]
Array<integer>
resolutionId[]
Array<integer>
parentChild

Parent/child issue filter.

  • 0: All
  • 1: Exclude child issues
  • 2: Only child issues
  • 3: Neither parent nor child
  • 4: Only parent issues
number
Allowed values: 0 1 2 3 4
attachment
boolean
sharedFile
boolean
sort

Sort field for issue list.

string
Allowed values: issueType category version milestone summary status priority attachment sharedFile created createdUser updated updatedUser assignee startDate dueDate estimatedHours actualHours childIssue
order

Sort order direction.

string
Allowed values: asc desc
offset
integer format: int32
count
integer format: int32
default: 20 >= 1 <= 100
createdSince
string format: date
createdUntil
string format: date
updatedSince
string format: date
updatedUntil
string format: date
startDateSince
string format: date
startDateUntil
string format: date
dueDateSince
string format: date
dueDateUntil
string format: date
id[]
Array<integer>
parentIssueId[]
Array<integer>
keyword
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The request has succeeded.

Array<object>

Backlog issue.

object
id
required
integer format: int64
projectId
required
integer format: int64
issueKey
required
string
keyId
required
integer format: int64
issueType
required

Project issue type.

object
id
required
integer format: int64
projectId
required
integer format: int64
name
required
string
color
required
string
displayOrder
required
integer format: int32
templateSummary
string
nullable
templateDescription
string
nullable
summary
required
string
description
required
string
resolution
required
object
id
required
integer format: int64
name
required
string
priority
required

Priority level.

object
id
required
integer format: int64
name
required
string
status
required

Project issue status.

object
id
required
integer format: int64
projectId
required
integer format: int64
name
required
string
color
required
string
displayOrder
required
integer format: int32
assignee
required
object
id
required
integer format: int64
userId
required
string
name
required
string
roleType
required

User role type.

  • 1: Administrator
  • 2: Normal User
  • 3: Reporter
  • 4: Viewer
  • 5: Guest Reporter
  • 6: Guest Viewer
number
Allowed values: 1 2 3 4 5 6
lang
required
string
nullable
mailAddress
required
string
lastLoginTime
required
string format: date-time
nullable
nulabAccount
required
object
nulabId
required
string
name
required
string
uniqueId
required
string
category
required
Array<object>

Project category.

object
id
required
integer format: int64
name
required
string
displayOrder
required
integer format: int32
versions
required
Array<object>

Project version / milestone.

object
id
required
integer format: int64
projectId
required
integer format: int64
name
required
string
description
required
string
startDate
required
string format: date
nullable
releaseDueDate
required
string format: date
nullable
archived
required
boolean
displayOrder
required
integer format: int32
milestone
required
Array<object>

Project version / milestone.

object
id
required
integer format: int64
projectId
required
integer format: int64
name
required
string
description
required
string
startDate
required
string format: date
nullable
releaseDueDate
required
string format: date
nullable
archived
required
boolean
displayOrder
required
integer format: int32
startDate
required
string format: date-time
nullable
dueDate
required
string format: date-time
nullable
estimatedHours
required
number format: double
nullable
actualHours
required
number format: double
nullable
parentIssueId
required
integer format: int64
nullable
createdUser
required

Backlog user.

object
id
required
integer format: int64
userId
required
string
name
required
string
roleType
required

User role type.

  • 1: Administrator
  • 2: Normal User
  • 3: Reporter
  • 4: Viewer
  • 5: Guest Reporter
  • 6: Guest Viewer
number
Allowed values: 1 2 3 4 5 6
lang
required
string
nullable
mailAddress
required
string
lastLoginTime
required
string format: date-time
nullable
nulabAccount
required
object
nulabId
required
string
name
required
string
uniqueId
required
string
created
required
string format: date-time
updatedUser
required

Backlog user.

object
id
required
integer format: int64
userId
required
string
name
required
string
roleType
required

User role type.

  • 1: Administrator
  • 2: Normal User
  • 3: Reporter
  • 4: Viewer
  • 5: Guest Reporter
  • 6: Guest Viewer
number
Allowed values: 1 2 3 4 5 6
lang
required
string
nullable
mailAddress
required
string
lastLoginTime
required
string format: date-time
nullable
nulabAccount
required
object
nulabId
required
string
name
required
string
uniqueId
required
string
updated
required
string format: date-time
customFields
required
Array<object>

Custom field value as returned in an issue.

object
id
required
integer format: int64
fieldTypeId
required

Custom field type code.

  • 1: Text
  • 2: TextArea
  • 3: Numeric
  • 4: Date
  • 5: SingleList
  • 6: MultipleList
  • 7: CheckBox
  • 8: RadioButton
number
Allowed values: 1 2 3 4 5 6 7 8
name
required
string
value
required
attachments
required
Array<object>

Attachment summary (used in various list responses).

object
id
required
integer format: int64
name
required
string
size
required
integer format: int64
sharedFiles
required
Array<object>

Shared file information.

object
id
required
integer format: int64
type
required
string
dir
required
string
name
required
string
size
required
integer format: int64
createdUser
required

Backlog user.

object
id
required
integer format: int64
userId
required
string
name
required
string
roleType
required

User role type.

  • 1: Administrator
  • 2: Normal User
  • 3: Reporter
  • 4: Viewer
  • 5: Guest Reporter
  • 6: Guest Viewer
number
Allowed values: 1 2 3 4 5 6
lang
required
string
nullable
mailAddress
required
string
lastLoginTime
required
string format: date-time
nullable
nulabAccount
required
object
nulabId
required
string
name
required
string
uniqueId
required
string
created
required
string format: date-time
updatedUser
required

Backlog user.

object
id
required
integer format: int64
userId
required
string
name
required
string
roleType
required

User role type.

  • 1: Administrator
  • 2: Normal User
  • 3: Reporter
  • 4: Viewer
  • 5: Guest Reporter
  • 6: Guest Viewer
number
Allowed values: 1 2 3 4 5 6
lang
required
string
nullable
mailAddress
required
string
lastLoginTime
required
string format: date-time
nullable
nulabAccount
required
object
nulabId
required
string
name
required
string
uniqueId
required
string
updated
required
string format: date-time
stars
required
Array<object>

Star object.

object
id
required
integer format: int64
comment
required
string
nullable
url
required
string
title
required
string
presenter
required

Backlog user.

object
id
required
integer format: int64
userId
required
string
name
required
string
roleType
required

User role type.

  • 1: Administrator
  • 2: Normal User
  • 3: Reporter
  • 4: Viewer
  • 5: Guest Reporter
  • 6: Guest Viewer
number
Allowed values: 1 2 3 4 5 6
lang
required
string
nullable
mailAddress
required
string
lastLoginTime
required
string format: date-time
nullable
nulabAccount
required
object
nulabId
required
string
name
required
string
uniqueId
required
string
created
required
string format: date-time

default

Section titled “default ”

An unexpected error response.

Error response wrapper returned by all Backlog API error responses.

object
errors
required
Array<object>

Individual error detail returned by the Backlog API.

object
message
required

Error message.

string
code
required

Error code.

  • 1: InternalError
  • 2: LicenceError
  • 3: LicenceExpiredError
  • 4: AccessDeniedError
  • 5: UnauthorizedOperationError
  • 6: NoResourceError
  • 7: InvalidRequestError
  • 8: SpaceOverCapacityError
  • 9: ResourceOverflowError
  • 10: TooLargeFileError
  • 11: AuthenticationError
  • 12: RequiredMFAError
  • 13: TooManyRequestsError
integer format: int32
moreInfo
required

Additional information about the error.

string