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

Get list of notifications

GET
/notifications

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
minId
integer format: int64
maxId
integer format: int64
count
integer format: int32
default: 20 >= 1 <= 100
order

Sort order direction.

string
Allowed values: asc desc
resourceAlreadyRead
boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The request has succeeded.

Array<object>

Notification reason code.

  • 1: Assigned
  • 2: Commented
  • 3: Issue Created
  • 4: Issue Updated
  • 5: File Attached
  • 6: User Added to Project
  • 9: Other
  • 10: Pull Request Assigned
  • 11: Pull Request Commented
  • 12: Pull Request Added
  • 13: Pull Request Updated
object
id
required
integer format: int64
alreadyRead
required
boolean
reason
required
integer format: int32
resourceAlreadyRead
required
boolean
project
required

Backlog project.

object
id
required
integer format: int64
projectKey
required
string
name
required
string
chartEnabled
required
boolean
useResolvedForChart
required
boolean
subtaskingEnabled
required
boolean
projectLeaderCanEditProjectLeader
required
boolean
useWiki
required
boolean
useFileSharing
required
boolean
useWikiTreeView
required
boolean
useOriginalImageSizeAtWiki
required
boolean
useSubversion
required
boolean
useGit
required
boolean
textFormattingRule
required

Text formatting rule for spaces and projects.

string
Allowed values: backlog markdown
archived
required
boolean
displayOrder
required
integer format: int32
useDevAttributes
required
boolean
issue
required
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
comment
required
object
id
required
integer format: int64
content
required
string
changeLog
required
Array<object>

Change log entry in a comment.

object
field
required
string
newValue
required
string
nullable
originalValue
required
string
nullable
attachmentInfo
required
object
id
required
integer format: int64
name
required
string
attributeInfo
required
object
id
required
integer format: int64
typeId
required
string
notificationInfo
required
object
type
required
string
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
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
notifications
required
Array<object>

Notification attached to a comment.

object
id
required
integer format: int64
alreadyRead
required
boolean
reason
required
integer format: int32
user
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
resourceAlreadyRead
required
boolean
pullRequest
required
object
id
required
integer format: int64
projectId
required
integer format: int64
repositoryId
required
integer format: int64
number
required
integer format: int64
summary
required
string
description
required
string
base
required
string
branch
required
string
status
required

Pull request status.

object
id
required
integer format: int64
name
required
string
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
issue
required
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
baseCommit
required
string
nullable
branchCommit
required
string
nullable
mergeCommit
required
string
nullable
closeAt
required
string format: date-time
nullable
mergeAt
required
string format: date-time
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
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
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
pullRequestComment
required
object
id
required
integer format: int64
content
required
string
changeLog
required
Array<object>

Change log entry in a comment.

object
field
required
string
newValue
required
string
nullable
originalValue
required
string
nullable
attachmentInfo
required
object
id
required
integer format: int64
name
required
string
attributeInfo
required
object
id
required
integer format: int64
typeId
required
string
notificationInfo
required
object
type
required
string
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
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
notifications
required
Array<object>

Notification attached to a comment.

object
id
required
integer format: int64
alreadyRead
required
boolean
reason
required
integer format: int32
user
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
resourceAlreadyRead
required
boolean
sender
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