Contents
Get Issue List
Returns list of issues.
Role
All
Method
GET
URL
/api/v2/issues
Query parameters
| Parameter Name | Type | Description |
|---|---|---|
| projectId[] (Multiple) | Number | Project ID |
| issueTypeId[] (Multiple) | Number | Issue Type ID |
| categoryId[] (Multiple) | Number | Category ID |
| versionId[] (Multiple) | Number | Version ID |
| milestoneId[] (Multiple) | Number | Milestone ID |
| statusId[] (Multiple) | Number | Status ID API of status list for each project |
| priorityId[] (Multiple) | Number | Priority ID |
| assigneeId[] (Multiple) | Number | Assignee ID |
| createdUserId[] (Multiple) | Number | Created User ID |
| resolutionId[] (Multiple) | Number | Resolution ID |
| parentChild | Number | Subtasking 0: All 1: Exclude Child Issue 2: Child Issue 3: Neither Parent Issue nor Child Issue 4: Parent Issue |
| attachment | Boolean | True to make include Issue with Attachment |
| sharedFile | Boolean | True to make include Issue with File |
| sort | String | What to sort results by ”issueType" "category" "version" "milestone" "summary" "status" "priority" "attachment" "sharedFile" "created" "createdUser" "updated" "updatedUser" "assignee" "startDate" "dueDate" "estimatedHours" "actualHours" "childIssue" "customField_${id}“ |
| order | String | Order of the sort “asc” or “desc” default=“desc” |
| offset | Number | |
| count | Number | number of records to retrieve(1-100) default=20 |
| createdSince | String | Created since (yyyy-MM-dd) |
| createdUntil | String | Created until (yyyy-MM-dd) |
| updatedSince | String | Updated since (yyyy-MM-dd) |
| updatedUntil | String | Updated until (yyyy-MM-dd) |
| startDateSince | String | Start Date since (yyyy-MM-dd) |
| startDateUntil | String | Start Date until (yyyy-MM-dd) |
| dueDateSince | String | Due Date since (yyyy-MM-dd) |
| dueDateUntil | String | Due Date until (yyyy-MM-dd) |
| hasDueDate | Boolean | False to make include issues without due date. Setting true is not supported and will result in an error. |
| id[] (Multiple) | Number | Issue ID |
| parentIssueId[] (Multiple) | Number | Parent Issue ID |
| keyword | String | Keyword |
Custom Fields (Text)
| Parameter Name | Type | Description |
|---|---|---|
| customField_${id} | String | Keyword |
Custom Fields (Numeric)
| Parameter Name | Type | Description |
|---|---|---|
| customField_${id}_min | Number | Minimum |
| customField_${id}_max | Number | Maximum |
Custom Fields (Date)
| Parameter Name | Type | Description |
|---|---|---|
| customField_${id}_min | String | Date from |
| customField_${id}_max | String | Date to |
Custom Fields (List)
| Parameter Name | Type | Description |
|---|---|---|
| customField_${id}[] (Multiple) | Number | Value ID |
Response example
Status Line / Response Header
HTTP/1.1 200 OK
Content-Type:application/json;charset=utf-8
Response Body
[
{
"id": 1,
"projectId": 1,
"issueKey": "BLG-1",
"keyId": 1,
"issueType": {
"id": 2,
"projectId" :1,
"name": "Task",
"color": "#7ea800",
"displayOrder": 0
},
"summary": "first issue",
"description": "",
"resolution": null,
"priority": {
"id": 3,
"name": "Normal"
},
"status": {
"id": 1,
"projectId": 1,
"name": "Open",
"color": "#ed8077",
"displayOrder": 1000
},
"assignee": {
"id": 2,
"userId": "eguchi",
"name": "eguchi",
"roleType" :2,
"lang": null,
"nulabAccount": {
"nulabId": "tSaVeJfRxLURSAkgfbNAfCbM7PqddYLJ3nG3BELjx6eSTbu8LD",
"name": "eguchi",
"uniqueId": "eguchi"
},
"mailAddress": "eguchi@nulab.example",
"lastLoginTime": "2022-09-01T06:35:39Z"
},
"category": [],
"versions": [],
"milestone": [
{
"id": 30,
"projectId": 1,
"name": "wait for release",
"description": "",
"startDate": null,
"releaseDueDate": null,
"archived": false,
"displayOrder": 0
}
],
"startDate": null,
"dueDate": null,
"estimatedHours": null,
"actualHours": null,
"parentIssueId": null,
"createdUser": {
"id": 1,
"userId": "admin",
"name": "admin",
"roleType": 1,
"lang": "ja",
"nulabAccount": {
"nulabId": "Prm9ZD9DQD5snNWcSYSwZiQoA9WFBUEa2ySznrSnSQRhdC2X8G",
"name": "admin",
"uniqueId": "admin"
},
"mailAddress": "eguchi@nulab.example",
"lastLoginTime": "2022-09-01T06:35:39Z"
},
"created": "2012-07-23T06:10:15Z",
"updatedUser": {
"id": 1,
"userId": "admin",
"name": "admin",
"roleType": 1,
"lang": "ja",
"nulabAccount": {
"nulabId": "Prm9ZD9DQD5snNWcSYSwZiQoA9WFBUEa2ySznrSnSQRhdC2X8G",
"name": "admin",
"uniqueId": "admin"
},
"mailAddress": "eguchi@nulab.example",
"lastLoginTime": "2022-09-01T06:35:39Z"
},
"updated": "2013-02-07T08:09:49Z",
"customFields": [],
"attachments": [
{
"id": 1,
"name": "IMGP0088.JPG",
"size": 85079
},
// ...
],
"sharedFiles": [
{
"id": 454403,
"projectId": 5,
"type": "file",
"dir": "/userIcon/",
"name": "01_male clerk.png",
"size": 2735,
"createdUser": {
"id": 5686,
"userId": "takada",
"name": "takada",
"roleType":2,
"lang":"ja",
"nulabAccount": {
"nulabId": "r4iGCWu4mU64aGUJykJH4GhBwdAXMTAtVRQ5RwZTDpeaECoBs2",
"name": "takada",
"uniqueId": "takada"
},
"mailAddress":"takada@nulab.example",
"lastLoginTime": "2022-09-01T06:35:39Z"
},
"created": "2009-02-27T03:26:15Z",
"updatedUser": {
"id": 5686,
"userId": "takada",
"name": "takada",
"roleType": 2,
"lang": "ja",
"nulabAccount": {
"nulabId": "r4iGCWu4mU64aGUJykJH4GhBwdAXMTAtVRQ5RwZTDpeaECoBs2",
"name": "takada",
"uniqueId": "takada"
},
"mailAddress": "takada@nulab.example",
"lastLoginTime": "2022-09-01T06:35:39Z"
},
"updated":"2009-03-03T16:57:47Z"
},
// ...
],
"stars": [
{
"id": 10,
"comment": null,
"url": "https://xx.backlogtool.com/view/BLG-1",
"title": "[BLG-1] first issue | Show issue - Backlog",
"presenter": {
"id": 2,
"userId": "eguchi",
"name": "eguchi",
"roleType": 2,
"lang": "ja",
"nulabAccount": {
"nulabId": "tSaVeJfRxLURSAkgfbNAfCbM7PqddYLJ3nG3BELjx6eSTbu8LD",
"name": "eguchi",
"uniqueId": "eguchi"
},
"mailAddress": "eguchi@nulab.example",
"lastLoginTime": "2022-09-01T06:35:39Z"
},
"created":"2013-07-08T10:24:28Z"
},
// ...
]
}
]