Get Notification

Returns own notifications.

Role

All

Method

GET 

URL

/api/v2/notifications 

Query parameters

Parameter Name Type Description
minId Number minimum ID
maxId Number maximum ID
count Number number of records to retrieve(1-100) default=20
order String “asc” or “desc”
senderId Number sender ID

Response example

Status Line / Response Header

### Response Body 
HTTP/1.1 200 OK 
Content-Type:application/json;charset=utf-8 

Response Body

[ 
    { 
        "id": 299, 
        "alreadyRead": true, 
        "reason": 2, 
        "resourceAlreadyRead": true, 
        "project": { 
            "id": 2, 
            "projectKey": "TEST2", 
            "name": "test2", 
            "chartEnabled": true,
            "useResolvedForChart": true,
            "subtaskingEnabled": true,
            "projectLeaderCanEditProjectLeader": false,
            "useWiki": true,
            "useFileSharing": true,
            "useWikiTreeView": true,
            "useOriginalImageSizeAtWiki": false,
            "textFormattingRule": "backlog",
            "archived": false,
            "displayOrder": 3,
            "useDevAttributes": true
        }, 
        "issue": { 
            "id": 4531, 
            "projectId": 2, 
            "issueKey": "TEST2-17", 
            "keyId": 17, 
            "issueType": { 
                "id": 7, 
                "projectId": 2, 
                "name": "Bug", 
                "color": "#990000", 
                "displayOrder": 0 
            }, 
            "summary": "aaa", 
            "description": "", 
            "resolution": null, 
            "priority": { 
                "id": 3, 
                "name": "Normal" 
            }, 
            "status": { 
                "id": 1, 
                "projectId": 2,
                "name": "Open",
                "color": "#ed8077",
                "displayOrder": 1000 
            }, 
            "assignee": { 
                "id": 2, 
                "userId": "eguchi", 
                "name": "eguchi", 
                "roleType": 2, 
                "lang": null, 
                "mailAddress": "eguchi@nulab.example",
                "lastLoginTime": "2022-09-01T06:35:39Z"
            }, 
            "category": [], 
            "versions": [], 
            "milestone": [], 
            "startDate": "2013-08-29T15:00:00Z", 
            "dueDate": "2013-09-03T15:00:00Z", 
            "estimatedHours": null, 
            "actualHours": null, 
            "parentIssueId": null, 
            "createdUser": { 
                "id": 1, 
                "userId": "admin", 
                "name": "admin", 
                "roleType": 1, 
                "lang": "ja", 
                "mailAddress": "eguchi@nulab.example", 
                "lastLoginTime": "2022-09-01T06:35:39Z"
            }, 
            "created": "2013-04-23T07:38:59Z", 
            "updatedUser": { 
                "id": 1, 
                "userId": "admin", 
                "name": "admin", 
                "roleType": 1, 
                "lang": "ja", 
                "mailAddress": "eguchi@nulab.example", 
                "lastLoginTime": "2022-09-01T06:35:39Z"
            }, 
            "updated": "2013-09-06T09:25:41Z", 
            "customFields": [], 
            "attachments": [], 
            "sharedFiles": [], 
            "stars": [] 
        }, 
        "comment": { 
            "id": 7007, 
            "projectId": 5,
            "issueId": 50,
            "content": "hoge", 
            "changeLog": null, 
            "createdUser": { 
                "id": 2, 
                "userId": "eguchi", 
                "name": "eguchi", 
                "roleType": 2, 
                "lang": null, 
                "mailAddress": "eguchi@nulab.example", 
                "lastLoginTime": "2022-09-01T06:35:39Z"
            }, 
            "created": "2013-10-31T06:58:58Z", 
            "updated": "2013-10-31T06:58:58Z", 
            "stars": [], 
            "notifications": [] 
        }, 
        "pullRequest": null, 
        "pullRequestComment": null, 
        "sender": { 
            "id": 2, 
            "userId": "eguchi", 
            "name": "eguchi", 
            "roleType": 2, 
            "lang": null, 
            "mailAddress": "eguchi@nulab.example", 
            "lastLoginTime": "2022-09-01T06:35:39Z"
        }, 
        "created": "2013-10-31T06:58:59Z" 
    }, 
    ... 
] 

Response description

Parameter Name Type Description
reason Number notification of reason
1:Assigned to Issue
2:Issue Commented
3:Issue Created
4:Issue Updated
5:File Added
6:Project User Added
9:Other
10:Assigned to Pull Request
11:Comment Added on Pull Request
12:Pull Request Added
13:Pull Request Updated