Get Issue List

Returns list of issues.

Method

GET

URL

/api/v2/issues

Query Parameters

Parameter Name Type Description
projectId[] Number Project ID
issueTypeId[] Number Issue Type ID
categoryId[] Number Category ID
versionId[] Number Version ID
milestoneId[] Number Milestone ID
statusId[] Number Status ID
priorityId[] Number Priority ID
assigneeId[] Number Assignee ID
createdUserId[] Number Created User ID
resolutionId[] 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
createdUntil String Created until
updatedSince String Updated since
updatedUntil String Updated until
startDateSince String Start Date since
startDateUntil String Start Date until
dueDateSince String Due Date since
dueDateUntil String Due Date until
id[] Number Issue ID
parentIssueId[] 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}[] 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": "",
        "resolutions": null,
        "priority": {
            "id": 3,
            "name": "Normal"
        },
        "status": {
            "id": 1,
            "name": "Open"
        },
        "assignee": {
            "id": 2,
            "name": "eguchi",
            "roleType" :2,
            "lang": null,
            "mailAddress": "eguchi@nulab.example"
        },
        "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",
            "mailAddress": "eguchi@nulab.example"
        },
        "created": "2012-07-23T06:10:15Z",
        "updatedUser": {
            "id": 1,
            "userId": "admin",
            "name": "admin",
            "roleType": 1,
            "lang": "ja",
            "mailAddress": "eguchi@nulab.example"
        },
        "updated": "2013-02-07T08:09:49Z",
        "customFields": [],
        "attachments": [
            {
                "id": 1,
                "name": "IMGP0088.JPG",
                "size": 85079
            },
            ...
        ],
        "sharedFiles": [
            {
                "id": 454403,
                "type": "file",
                "dir": "/userIcon/",
                "name": "01_male clerk.png",
                "size": 2735,
                "createdUser": {
                    "id": 5686,
                    "userId": "takada",
                    "name": "takada",
                    "roleType":2,
                    "lang":"ja",
                    "mailAddress":"takada@nulab.example"
                },
                "created": "2009-02-27T03:26:15Z",
                "updatedUser": {
                    "id": 5686,
                    "userId": "takada",
                    "name": "takada",
                    "roleType": 2,
                    "lang": "ja",
                    "mailAddress": "takada@nulab.example"
                },
                "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",
                    "mailAddress": "eguchi@nulab.example"
                },
                "created":"2013-07-08T10:24:28Z"
            },
            ...
        ]
    }
]