Documentation

Resources

Developer

Get Support

DOCUMENTATION

Cloud

Data Center

Resources

Get support

Developer

DOCUMENTATION

Cloud

Data Center

Resources

Get support

Server

Jira Data Center / / Modules

board

Postman Collection

OpenAPI

Operations

GET

Get all boards

Returns all boards. This only includes boards that the user has permission to view.

Forge and OAuth2 apps cannot access this REST resource.

Request

Query parameters

maxResults

integer

name

string

projectKeyOrId

string

type

StringList

startAt

integer

Responses

Returns the requested boards, at the specified page of the results.

application/json

BoardBean

GET/agile/1.0/board

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/agile/1.0/board' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "id": 10001,
  "name": "Scrum Board",
  "self": "http://www.example.com/jira/rest/agile/1.0/board/10001",
  "type": "scrum"
}

POST

Create a new board

Creates a new board. Board name, type and filter Id is required.

name - Must be less than 255 characters.
type - Valid values: scrum, kanban
filterId - Id of a filter that the user has permissions to view. Note, if the user does not have the 'Create shared objects' permission and tries to create a shared board, a private board will be created instead (remember that board sharing depends on the filter sharing). Note:
If you want to create a new project with an associated board, use the JIRA platform REST API. For more information, see the Create project method. The projectTypeKey for software boards must be 'software' and the projectTemplateKey must be either com.pyxis.greenhopper.jira:gh-kanban-template or com.pyxis.greenhopper.jira:gh-scrum-template.
You can create a filter using the JIRA REST API. For more information, see the Create filter method.
If you do not ORDER BY the Rank field for the filter of your board, you will not be able to reorder issues on the board.

Forge and OAuth2 apps cannot access this REST resource.

Request

Request bodyapplication/json

Bean which contains board name, type and filter Id.

filterId

integer

name

string

type

string

Responses

Returns the created board.

application/json

BoardBean

POST/agile/1.0/board

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'http://{baseurl}/rest/agile/1.0/board' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "filterId": 10040,
  "name": "scrum board",
  "type": "scrum"
}'

201Response

{
  "id": 10001,
  "name": "Scrum Board",
  "self": "http://www.example.com/jira/rest/agile/1.0/board/10001",
  "type": "scrum"
}

GET

Get a single board

Returns a single board, for a given board Id.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

boardId

integer

Required

Responses

Returns the requested board.

application/json

BoardBean

GET/agile/1.0/board/{boardId}

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "id": 10001,
  "name": "Scrum Board",
  "self": "http://www.example.com/jira/rest/agile/1.0/board/10001",
  "type": "scrum"
}

DEL

Delete the board

Deletes the board.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

boardId

integer

Required

Responses

Returned if the board has been successfully removed.

DEL/agile/1.0/board/{boardId}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}' \
  --user 'email@example.com:<api_token>'

GET

Get all issues from the board's backlog

Returns all issues from a board's backlog, for a given board Id.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

boardId

integer

Required

Query parameters

expand

string

jql

string

maxResults

integer

validateQuery

boolean

fields

array<StringList>

startAt

integer

Responses

Returns the requested issues.

application/json

IssueBean

GET/agile/1.0/board/{boardId}/backlog

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/backlog' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "changelog": {
    "histories": [
      {
        "author": {},
        "created": "<string>",
        "historyMetadata": {},
        "id": "<string>",
        "items": [
          {}
        ]
      }
    ],
    "maxResults": 2154,
    "startAt": 2154,
    "total": 2154
  },
  "editmeta": {},
  "fields": {
    "watcher": {
      "self": "http://www.example.com/jira/rest/api/2/issue/EX-1/watchers",
      "isWatching": false,
      "watchCount": 1,
      "watchers": [
        {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        }
      ]
    },
    "attachment": [
      {
        "self": "http://www.example.com/jira/rest/api/2.0/attachments/10000",
        "filename": "picture.jpg",
        "author": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "key": "JIRAUSER10100",
          "name": "fred",
          "emailAddress": "fred@example.com",
          "avatarUrls": {
            "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred",
            "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred",
            "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred",
            "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred"
          },
          "displayName": "Fred F. User",
          "active": true,
          "deleted": false,
          "timeZone": "Australia/Sydney",
          "locale": "en_AU",
          "lastLoginTime": "2023-08-30T16:37:01+1000"
        },
        "created": "2024-05-23T14:47:28.592+0000",
        "size": 23123,
        "mimeType": "image/jpeg",
        "content": "http://www.example.com/jira/attachments/10000",
        "thumbnail": "http://www.example.com/jira/secure/thumbnail/10000"
      }
    ],
    "sub-tasks": [
      {
        "id": "10000",
        "type": {
          "id": "10000",
          "name": "",
          "inward": "Parent",
          "outward": "Sub-task"
        },
        "outwardIssue": {
          "id": "10003",
          "key": "EX-2",
          "self": "http://www.example.com/jira/rest/api/2/issue/EX-2",
          "fields": {
            "status": {
              "iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png",
              "name": "Open"
            }
          }
        }
      }
    ],
    "description": "example bug report",
    "project": {
      "self": "http://www.example.com/jira/rest/api/2/project/EX",
      "id": "10000",
      "key": "EX",
      "name": "Example",
      "avatarUrls": {
        "48x48": "http://www.example.com/jira/secure/projectavatar?size=large&pid=10000",
        "24x24": "http://www.example.com/jira/secure/projectavatar?size=small&pid=10000",
        "16x16": "http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000",
        "32x32": "http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000"
      },
      "projectCategory": {
        "self": "http://www.example.com/jira/rest/api/2/projectCategory/10000",
        "id": "10000",
        "name": "FIRST",
        "description": "First Project Category"
      }
    },
    "comment": [
      {
        "self": "http://www.example.com/jira/rest/api/2/issue/10010/comment/10000",
        "id": "10000",
        "author": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
        "updateAuthor": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "created": "2024-05-23T14:47:28.538+0000",
        "updated": "2024-05-23T14:47:28.538+0000",
        "visibility": {
          "type": "role",
          "value": "Administrators"
        }
      }
    ],
    "issuelinks": [
      {
        "id": "10001",
        "type": {
          "id": "10000",
          "name": "Dependent",
          "inward": "depends on",
          "outward": "is depended by"
        },
        "outwardIssue": {
          "id": "10004L",
          "key": "PRJ-2",
          "self": "http://www.example.com/jira/rest/api/2/issue/PRJ-2",
          "fields": {
            "status": {
              "iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png",
              "name": "Open"
            }
          }
        }
      },
      {
        "id": "10002",
        "type": {
          "id": "10000",
          "name": "Dependent",
          "inward": "depends on",
          "outward": "is depended by"
        },
        "inwardIssue": {
          "id": "10004",
          "key": "PRJ-3",
          "self": "http://www.example.com/jira/rest/api/2/issue/PRJ-3",
          "fields": {
            "status": {
              "iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png",
              "name": "Open"
            }
          }
        }
      }
    ],
    "worklog": [
      {
        "self": "http://www.example.com/jira/rest/api/2/issue/10010/worklog/10000",
        "author": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "updateAuthor": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "comment": "I did some work here.",
        "updated": "2024-05-23T14:47:28.599+0000",
        "visibility": {
          "type": "group",
          "value": "jira-developers"
        },
        "started": "2024-05-23T14:47:28.598+0000",
        "timeSpent": "3h 20m",
        "timeSpentSeconds": 12000,
        "id": "100028",
        "issueId": "10002"
      }
    ],
    "updated": 1,
    "timetracking": {
      "originalEstimate": "10m",
      "remainingEstimate": "3m",
      "timeSpent": "6m",
      "originalEstimateSeconds": 600,
      "remainingEstimateSeconds": 200,
      "timeSpentSeconds": 400
    }
  },
  "fieldsToInclude": {
    "included": [
      "<string>"
    ]
  },
  "id": "10000",
  "key": "HSP-1",
  "names": {},
  "operations": {
    "linkGroups": [
      {
        "groups": [],
        "header": {},
        "id": "<string>",
        "links": [
          {}
        ],
        "styleClass": "<string>",
        "weight": 2154
      }
    ]
  },
  "properties": {
    "properties": {}
  },
  "renderedFields": {},
  "schema": {},
  "self": "https://jira.atlassian.com/rest/api/2/issue/10000",
  "transitions": [
    {
      "description": "Close the issue.",
      "fields": {},
      "id": "2",
      "name": "Close Issue",
      "opsbarSequence": 10,
      "to": {
        "description": "The issue is currently being worked on.",
        "iconUrl": "http://localhost:8090/jira/images/icons/progress.gif",
        "id": "10000",
        "name": "In Progress",
        "self": "http://localhost:8090/jira/rest/api/2.0/status/10000",
        "statusCategory": {},
        "statusColor": "green"
      }
    }
  ],
  "versionedRepresentations": {}
}

GET

Get the board configuration

Get the board configuration. The response contains the following fields:

id - Id of the board.
name - Name of the board.
filter - Reference to the filter used by the given board.
subQuery (Kanban only) - JQL subquery used by the given board.
columnConfig - The column configuration lists the columns for the board, in the order defined in the column configuration. For each column, it shows the issue status mapping as well as the constraint type (Valid values: none, issueCount, issueCountExclSubs) for the min/max number of issues. Note, the last column with statuses mapped to it is treated as the "Done" column, which means that issues in that column will be marked as already completed.
estimation (Scrum only) - Contains information about type of estimation used for the board. Valid values: none, issueCount, field. If the estimation type is "field", the Id and display name of the field used for estimation is also returned. Note, estimates for an issue can be updated by a PUT /rest/api/2/issue/{issueIdOrKey} request, however the fields must be on the screen. "timeoriginalestimate" field will never be on the screen, so in order to update it "originalEstimate" in "timetracking" field should be updated.
ranking - Contains information about custom field used for ranking in the given board.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

boardId

integer

Required

Responses

Returns the configuration of the board for given boardId.

application/json

BoardConfigBean

GET/agile/1.0/board/{boardId}/configuration

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/configuration' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "columnConfig": {
    "columns": [
      {
        "max": 4,
        "min": 2,
        "name": "To Do",
        "statuses": [
          {}
        ]
      }
    ],
    "constraintType": "issueCount"
  },
  "estimation": {
    "field": {
      "displayName": "Story Points",
      "fieldId": "customfield_10002"
    },
    "type": "field"
  },
  "filter": {
    "id": "1001",
    "self": "http://www.example.com/jira/rest/agile/1.0/filter/1001"
  },
  "id": 10001,
  "name": "Scrum",
  "ranking": {
    "rankCustomFieldId": 10020
  },
  "self": "http://www.example.com/jira/rest/agile/1.0/board/10001",
  "subQuery": {
    "query": "project = HSP"
  },
  "type": "scrum"
}

GET

Get all epics from the board

Returns all epics from the board, for the given board Id. This only includes epics that the user has permission to view. Note, if the user does not have permission to view the board, no epics will be returned at all.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

boardId

integer

Required

Query parameters

maxResults

integer

done

string

startAt

integer

Responses

Returns the requested epics, at the specified page of the results.

application/json

EpicBean

GET/agile/1.0/board/{boardId}/epic

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/epic' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "color": {
    "key": "ghx-label-1"
  },
  "done": true,
  "id": 10000,
  "key": "PR-1",
  "name": "Epic 1",
  "self": "http://www.example.com/jira/rest/api/2/issue/10000",
  "summary": "Epic 1 summary"
}

GET

Get all issues without an epic

Returns all issues that do not belong to any epic on a board, for a given board Id.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

boardId

integer

Required

Query parameters

expand

string

jql

string

maxResults

integer

validateQuery

boolean

fields

array<StringList>

startAt

integer

Responses

Returns the requested issues, at the specified page of the results.

application/json

IssueBean

GET/agile/1.0/board/{boardId}/epic/none/issue

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/epic/none/issue' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "changelog": {
    "histories": [
      {
        "author": {},
        "created": "<string>",
        "historyMetadata": {},
        "id": "<string>",
        "items": [
          {}
        ]
      }
    ],
    "maxResults": 2154,
    "startAt": 2154,
    "total": 2154
  },
  "editmeta": {},
  "fields": {
    "watcher": {
      "self": "http://www.example.com/jira/rest/api/2/issue/EX-1/watchers",
      "isWatching": false,
      "watchCount": 1,
      "watchers": [
        {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        }
      ]
    },
    "attachment": [
      {
        "self": "http://www.example.com/jira/rest/api/2.0/attachments/10000",
        "filename": "picture.jpg",
        "author": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "key": "JIRAUSER10100",
          "name": "fred",
          "emailAddress": "fred@example.com",
          "avatarUrls": {
            "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred",
            "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred",
            "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred",
            "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred"
          },
          "displayName": "Fred F. User",
          "active": true,
          "deleted": false,
          "timeZone": "Australia/Sydney",
          "locale": "en_AU",
          "lastLoginTime": "2023-08-30T16:37:01+1000"
        },
        "created": "2024-05-23T14:47:28.592+0000",
        "size": 23123,
        "mimeType": "image/jpeg",
        "content": "http://www.example.com/jira/attachments/10000",
        "thumbnail": "http://www.example.com/jira/secure/thumbnail/10000"
      }
    ],
    "sub-tasks": [
      {
        "id": "10000",
        "type": {
          "id": "10000",
          "name": "",
          "inward": "Parent",
          "outward": "Sub-task"
        },
        "outwardIssue": {
          "id": "10003",
          "key": "EX-2",
          "self": "http://www.example.com/jira/rest/api/2/issue/EX-2",
          "fields": {
            "status": {
              "iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png",
              "name": "Open"
            }
          }
        }
      }
    ],
    "description": "example bug report",
    "project": {
      "self": "http://www.example.com/jira/rest/api/2/project/EX",
      "id": "10000",
      "key": "EX",
      "name": "Example",
      "avatarUrls": {
        "48x48": "http://www.example.com/jira/secure/projectavatar?size=large&pid=10000",
        "24x24": "http://www.example.com/jira/secure/projectavatar?size=small&pid=10000",
        "16x16": "http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000",
        "32x32": "http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000"
      },
      "projectCategory": {
        "self": "http://www.example.com/jira/rest/api/2/projectCategory/10000",
        "id": "10000",
        "name": "FIRST",
        "description": "First Project Category"
      }
    },
    "comment": [
      {
        "self": "http://www.example.com/jira/rest/api/2/issue/10010/comment/10000",
        "id": "10000",
        "author": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
        "updateAuthor": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "created": "2024-05-23T14:47:28.538+0000",
        "updated": "2024-05-23T14:47:28.538+0000",
        "visibility": {
          "type": "role",
          "value": "Administrators"
        }
      }
    ],
    "issuelinks": [
      {
        "id": "10001",
        "type": {
          "id": "10000",
          "name": "Dependent",
          "inward": "depends on",
          "outward": "is depended by"
        },
        "outwardIssue": {
          "id": "10004L",
          "key": "PRJ-2",
          "self": "http://www.example.com/jira/rest/api/2/issue/PRJ-2",
          "fields": {
            "status": {
              "iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png",
              "name": "Open"
            }
          }
        }
      },
      {
        "id": "10002",
        "type": {
          "id": "10000",
          "name": "Dependent",
          "inward": "depends on",
          "outward": "is depended by"
        },
        "inwardIssue": {
          "id": "10004",
          "key": "PRJ-3",
          "self": "http://www.example.com/jira/rest/api/2/issue/PRJ-3",
          "fields": {
            "status": {
              "iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png",
              "name": "Open"
            }
          }
        }
      }
    ],
    "worklog": [
      {
        "self": "http://www.example.com/jira/rest/api/2/issue/10010/worklog/10000",
        "author": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "updateAuthor": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "comment": "I did some work here.",
        "updated": "2024-05-23T14:47:28.599+0000",
        "visibility": {
          "type": "group",
          "value": "jira-developers"
        },
        "started": "2024-05-23T14:47:28.598+0000",
        "timeSpent": "3h 20m",
        "timeSpentSeconds": 12000,
        "id": "100028",
        "issueId": "10002"
      }
    ],
    "updated": 1,
    "timetracking": {
      "originalEstimate": "10m",
      "remainingEstimate": "3m",
      "timeSpent": "6m",
      "originalEstimateSeconds": 600,
      "remainingEstimateSeconds": 200,
      "timeSpentSeconds": 400
    }
  },
  "fieldsToInclude": {
    "included": [
      "<string>"
    ]
  },
  "id": "10000",
  "key": "HSP-1",
  "names": {},
  "operations": {
    "linkGroups": [
      {
        "groups": [],
        "header": {},
        "id": "<string>",
        "links": [
          {}
        ],
        "styleClass": "<string>",
        "weight": 2154
      }
    ]
  },
  "properties": {
    "properties": {}
  },
  "renderedFields": {},
  "schema": {},
  "self": "https://jira.atlassian.com/rest/api/2/issue/10000",
  "transitions": [
    {
      "description": "Close the issue.",
      "fields": {},
      "id": "2",
      "name": "Close Issue",
      "opsbarSequence": 10,
      "to": {
        "description": "The issue is currently being worked on.",
        "iconUrl": "http://localhost:8090/jira/images/icons/progress.gif",
        "id": "10000",
        "name": "In Progress",
        "self": "http://localhost:8090/jira/rest/api/2.0/status/10000",
        "statusCategory": {},
        "statusColor": "green"
      }
    }
  ],
  "versionedRepresentations": {}
}

GET

Get all issues for a specific epic

Returns all issues that belong to an epic on the board, for the given epic Id and the board Id.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

epicId

integer

Required

boardId

integer

Required

Query parameters

expand

string

jql

string

maxResults

integer

validateQuery

boolean

fields

array<StringList>

startAt

integer

Responses

Returns the requested issues, at the specified page of the results.

application/json

IssueBean

GET/agile/1.0/board/{boardId}/epic/{epicId}/issue

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/epic/{epicId}/issue' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "changelog": {
    "histories": [
      {
        "author": {},
        "created": "<string>",
        "historyMetadata": {},
        "id": "<string>",
        "items": [
          {}
        ]
      }
    ],
    "maxResults": 2154,
    "startAt": 2154,
    "total": 2154
  },
  "editmeta": {},
  "fields": {
    "watcher": {
      "self": "http://www.example.com/jira/rest/api/2/issue/EX-1/watchers",
      "isWatching": false,
      "watchCount": 1,
      "watchers": [
        {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        }
      ]
    },
    "attachment": [
      {
        "self": "http://www.example.com/jira/rest/api/2.0/attachments/10000",
        "filename": "picture.jpg",
        "author": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "key": "JIRAUSER10100",
          "name": "fred",
          "emailAddress": "fred@example.com",
          "avatarUrls": {
            "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred",
            "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred",
            "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred",
            "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred"
          },
          "displayName": "Fred F. User",
          "active": true,
          "deleted": false,
          "timeZone": "Australia/Sydney",
          "locale": "en_AU",
          "lastLoginTime": "2023-08-30T16:37:01+1000"
        },
        "created": "2024-05-23T14:47:28.592+0000",
        "size": 23123,
        "mimeType": "image/jpeg",
        "content": "http://www.example.com/jira/attachments/10000",
        "thumbnail": "http://www.example.com/jira/secure/thumbnail/10000"
      }
    ],
    "sub-tasks": [
      {
        "id": "10000",
        "type": {
          "id": "10000",
          "name": "",
          "inward": "Parent",
          "outward": "Sub-task"
        },
        "outwardIssue": {
          "id": "10003",
          "key": "EX-2",
          "self": "http://www.example.com/jira/rest/api/2/issue/EX-2",
          "fields": {
            "status": {
              "iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png",
              "name": "Open"
            }
          }
        }
      }
    ],
    "description": "example bug report",
    "project": {
      "self": "http://www.example.com/jira/rest/api/2/project/EX",
      "id": "10000",
      "key": "EX",
      "name": "Example",
      "avatarUrls": {
        "48x48": "http://www.example.com/jira/secure/projectavatar?size=large&pid=10000",
        "24x24": "http://www.example.com/jira/secure/projectavatar?size=small&pid=10000",
        "16x16": "http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000",
        "32x32": "http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000"
      },
      "projectCategory": {
        "self": "http://www.example.com/jira/rest/api/2/projectCategory/10000",
        "id": "10000",
        "name": "FIRST",
        "description": "First Project Category"
      }
    },
    "comment": [
      {
        "self": "http://www.example.com/jira/rest/api/2/issue/10010/comment/10000",
        "id": "10000",
        "author": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
        "updateAuthor": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "created": "2024-05-23T14:47:28.538+0000",
        "updated": "2024-05-23T14:47:28.538+0000",
        "visibility": {
          "type": "role",
          "value": "Administrators"
        }
      }
    ],
    "issuelinks": [
      {
        "id": "10001",
        "type": {
          "id": "10000",
          "name": "Dependent",
          "inward": "depends on",
          "outward": "is depended by"
        },
        "outwardIssue": {
          "id": "10004L",
          "key": "PRJ-2",
          "self": "http://www.example.com/jira/rest/api/2/issue/PRJ-2",
          "fields": {
            "status": {
              "iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png",
              "name": "Open"
            }
          }
        }
      },
      {
        "id": "10002",
        "type": {
          "id": "10000",
          "name": "Dependent",
          "inward": "depends on",
          "outward": "is depended by"
        },
        "inwardIssue": {
          "id": "10004",
          "key": "PRJ-3",
          "self": "http://www.example.com/jira/rest/api/2/issue/PRJ-3",
          "fields": {
            "status": {
              "iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png",
              "name": "Open"
            }
          }
        }
      }
    ],
    "worklog": [
      {
        "self": "http://www.example.com/jira/rest/api/2/issue/10010/worklog/10000",
        "author": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "updateAuthor": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "comment": "I did some work here.",
        "updated": "2024-05-23T14:47:28.599+0000",
        "visibility": {
          "type": "group",
          "value": "jira-developers"
        },
        "started": "2024-05-23T14:47:28.598+0000",
        "timeSpent": "3h 20m",
        "timeSpentSeconds": 12000,
        "id": "100028",
        "issueId": "10002"
      }
    ],
    "updated": 1,
    "timetracking": {
      "originalEstimate": "10m",
      "remainingEstimate": "3m",
      "timeSpent": "6m",
      "originalEstimateSeconds": 600,
      "remainingEstimateSeconds": 200,
      "timeSpentSeconds": 400
    }
  },
  "fieldsToInclude": {
    "included": [
      "<string>"
    ]
  },
  "id": "10000",
  "key": "HSP-1",
  "names": {},
  "operations": {
    "linkGroups": [
      {
        "groups": [],
        "header": {},
        "id": "<string>",
        "links": [
          {}
        ],
        "styleClass": "<string>",
        "weight": 2154
      }
    ]
  },
  "properties": {
    "properties": {}
  },
  "renderedFields": {},
  "schema": {},
  "self": "https://jira.atlassian.com/rest/api/2/issue/10000",
  "transitions": [
    {
      "description": "Close the issue.",
      "fields": {},
      "id": "2",
      "name": "Close Issue",
      "opsbarSequence": 10,
      "to": {
        "description": "The issue is currently being worked on.",
        "iconUrl": "http://localhost:8090/jira/images/icons/progress.gif",
        "id": "10000",
        "name": "In Progress",
        "self": "http://localhost:8090/jira/rest/api/2.0/status/10000",
        "statusCategory": {},
        "statusColor": "green"
      }
    }
  ],
  "versionedRepresentations": {}
}

GET

Get all issues from a board

Returns all issues from a board, for a given board Id. This only includes issues that the user has permission to view. Note, if the user does not have permission to view the board, no issues will be returned at all. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

boardId

integer

Required

Query parameters

expand

string

jql

string

maxResults

integer

validateQuery

boolean

fields

array<StringList>

startAt

integer

Responses

Returns the requested issues.

application/json

IssueBean

GET/agile/1.0/board/{boardId}/issue

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/issue' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "changelog": {
    "histories": [
      {
        "author": {},
        "created": "<string>",
        "historyMetadata": {},
        "id": "<string>",
        "items": [
          {}
        ]
      }
    ],
    "maxResults": 2154,
    "startAt": 2154,
    "total": 2154
  },
  "editmeta": {},
  "fields": {
    "watcher": {
      "self": "http://www.example.com/jira/rest/api/2/issue/EX-1/watchers",
      "isWatching": false,
      "watchCount": 1,
      "watchers": [
        {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        }
      ]
    },
    "attachment": [
      {
        "self": "http://www.example.com/jira/rest/api/2.0/attachments/10000",
        "filename": "picture.jpg",
        "author": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "key": "JIRAUSER10100",
          "name": "fred",
          "emailAddress": "fred@example.com",
          "avatarUrls": {
            "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred",
            "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred",
            "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred",
            "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred"
          },
          "displayName": "Fred F. User",
          "active": true,
          "deleted": false,
          "timeZone": "Australia/Sydney",
          "locale": "en_AU",
          "lastLoginTime": "2023-08-30T16:37:01+1000"
        },
        "created": "2024-05-23T14:47:28.592+0000",
        "size": 23123,
        "mimeType": "image/jpeg",
        "content": "http://www.example.com/jira/attachments/10000",
        "thumbnail": "http://www.example.com/jira/secure/thumbnail/10000"
      }
    ],
    "sub-tasks": [
      {
        "id": "10000",
        "type": {
          "id": "10000",
          "name": "",
          "inward": "Parent",
          "outward": "Sub-task"
        },
        "outwardIssue": {
          "id": "10003",
          "key": "EX-2",
          "self": "http://www.example.com/jira/rest/api/2/issue/EX-2",
          "fields": {
            "status": {
              "iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png",
              "name": "Open"
            }
          }
        }
      }
    ],
    "description": "example bug report",
    "project": {
      "self": "http://www.example.com/jira/rest/api/2/project/EX",
      "id": "10000",
      "key": "EX",
      "name": "Example",
      "avatarUrls": {
        "48x48": "http://www.example.com/jira/secure/projectavatar?size=large&pid=10000",
        "24x24": "http://www.example.com/jira/secure/projectavatar?size=small&pid=10000",
        "16x16": "http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000",
        "32x32": "http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000"
      },
      "projectCategory": {
        "self": "http://www.example.com/jira/rest/api/2/projectCategory/10000",
        "id": "10000",
        "name": "FIRST",
        "description": "First Project Category"
      }
    },
    "comment": [
      {
        "self": "http://www.example.com/jira/rest/api/2/issue/10010/comment/10000",
        "id": "10000",
        "author": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
        "updateAuthor": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "created": "2024-05-23T14:47:28.538+0000",
        "updated": "2024-05-23T14:47:28.538+0000",
        "visibility": {
          "type": "role",
          "value": "Administrators"
        }
      }
    ],
    "issuelinks": [
      {
        "id": "10001",
        "type": {
          "id": "10000",
          "name": "Dependent",
          "inward": "depends on",
          "outward": "is depended by"
        },
        "outwardIssue": {
          "id": "10004L",
          "key": "PRJ-2",
          "self": "http://www.example.com/jira/rest/api/2/issue/PRJ-2",
          "fields": {
            "status": {
              "iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png",
              "name": "Open"
            }
          }
        }
      },
      {
        "id": "10002",
        "type": {
          "id": "10000",
          "name": "Dependent",
          "inward": "depends on",
          "outward": "is depended by"
        },
        "inwardIssue": {
          "id": "10004",
          "key": "PRJ-3",
          "self": "http://www.example.com/jira/rest/api/2/issue/PRJ-3",
          "fields": {
            "status": {
              "iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png",
              "name": "Open"
            }
          }
        }
      }
    ],
    "worklog": [
      {
        "self": "http://www.example.com/jira/rest/api/2/issue/10010/worklog/10000",
        "author": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "updateAuthor": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "comment": "I did some work here.",
        "updated": "2024-05-23T14:47:28.599+0000",
        "visibility": {
          "type": "group",
          "value": "jira-developers"
        },
        "started": "2024-05-23T14:47:28.598+0000",
        "timeSpent": "3h 20m",
        "timeSpentSeconds": 12000,
        "id": "100028",
        "issueId": "10002"
      }
    ],
    "updated": 1,
    "timetracking": {
      "originalEstimate": "10m",
      "remainingEstimate": "3m",
      "timeSpent": "6m",
      "originalEstimateSeconds": 600,
      "remainingEstimateSeconds": 200,
      "timeSpentSeconds": 400
    }
  },
  "fieldsToInclude": {
    "included": [
      "<string>"
    ]
  },
  "id": "10000",
  "key": "HSP-1",
  "names": {},
  "operations": {
    "linkGroups": [
      {
        "groups": [],
        "header": {},
        "id": "<string>",
        "links": [
          {}
        ],
        "styleClass": "<string>",
        "weight": 2154
      }
    ]
  },
  "properties": {
    "properties": {}
  },
  "renderedFields": {},
  "schema": {},
  "self": "https://jira.atlassian.com/rest/api/2/issue/10000",
  "transitions": [
    {
      "description": "Close the issue.",
      "fields": {},
      "id": "2",
      "name": "Close Issue",
      "opsbarSequence": 10,
      "to": {
        "description": "The issue is currently being worked on.",
        "iconUrl": "http://localhost:8090/jira/images/icons/progress.gif",
        "id": "10000",
        "name": "In Progress",
        "self": "http://localhost:8090/jira/rest/api/2.0/status/10000",
        "statusCategory": {},
        "statusColor": "green"
      }
    }
  ],
  "versionedRepresentations": {}
}

GET

Get all projects associated with the board

Returns all projects that are associated with the board, for the given board Id. A project is associated with a board only if the board filter explicitly filters issues by the project and guaranties that all issues will come for one of those projects e.g. board's filter with "project in (PR-1, PR-1) OR reporter = admin" jql Projects are returned only if user can browse all projects that are associated with the board. Note, if the user does not have permission to view the board, no projects will be returned at all. Returned projects are ordered by the name.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

boardId

integer

Required

Query parameters

maxResults

integer

startAt

integer

Responses

Returns the board's projects, at the specified page of the results.

application/json

ProjectJsonBean

GET/agile/1.0/board/{boardId}/project

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/project' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "avatarUrls": {},
  "id": "<string>",
  "key": "<string>",
  "name": "<string>",
  "projectCategory": {
    "description": "This is a project category",
    "id": "10000",
    "name": "My Project Category",
    "self": "http://www.example.com/jira/rest/api/2/projectCategory/10000"
  },
  "projectTypeKey": "<string>",
  "self": "<string>"
}

GET

Get all properties keys for a board

Returns the keys of all properties for the board identified by the id. The user who retrieves the property keys is required to have permissions to view the board.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

boardId

string

Required

Responses

Returns the requested property keys.

application/json

EntityPropertiesKeysBean

GET/agile/1.0/board/{boardId}/properties

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/properties' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "keys": [
    {
      "key": "issue.support",
      "self": "http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support"
    }
  ]
}

GET

Get a property from a board

Returns the value of the property with a given key from the board identified by the provided id. The user who retrieves the property is required to have permissions to view the board.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

propertyKey

string

Required

boardId

string

Required

Responses

Returns the requested property.

application/json

EntityPropertiesKeysBean

GET/agile/1.0/board/{boardId}/properties/{propertyKey}

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/properties/{propertyKey}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "keys": [
    {
      "key": "issue.support",
      "self": "http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support"
    }
  ]
}

PUT

Update a board's property

Sets the value of the specified board's property. You can use this resource to store a custom data against the board identified by the id. The user who stores the data is required to have permissions to modify the board.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

propertyKey

string

Required

boardId

string

Required

Responses

Returned if the board property is successfully updated.

application/json

EntityPropertiesKeysBean

PUT/agile/1.0/board/{boardId}/properties/{propertyKey}

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/properties/{propertyKey}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "keys": [
    {
      "key": "issue.support",
      "self": "http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support"
    }
  ]
}

DEL

Delete a property from a board

Removes the property from the board identified by the id. Ths user removing the property is required to have permissions to modify the board.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

propertyKey

string

Required

boardId

string

Required

Responses

Returned if the board property was removed successfully.

DEL/agile/1.0/board/{boardId}/properties/{propertyKey}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/properties/{propertyKey}' \
  --user 'email@example.com:<api_token>'

GET

Get the value of the refined velocity setting

Returns the value of the setting for refined velocity chart

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

boardId

integer

Required

Responses

Returned if the board exists and the property was found.

application/json

BooleanSettingBean

GET/agile/1.0/board/{boardId}/settings/refined-velocity

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/settings/refined-velocity' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

1
2
3

{
  "value": true
}

PUT

Update the board's refined velocity setting

Sets the value of the specified board's refined velocity setting.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

boardId

integer

Required

Request bodyapplication/json application/x-www-form-urlencoded

The request containing value of the board's property. The value has to a valid, non-empty JSON conforming to http://tools.ietf.org/html/rfc4627. The maximum length of the property value is 32768 bytes.

value

boolean

Responses

Returned if the board property is successfully updated.

PUT/agile/1.0/board/{boardId}/settings/refined-velocity

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/settings/refined-velocity' \
  --user 'email@example.com:<api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "value": true
}'

GET

Get all sprints from a board

Returns all sprints from a board, for a given board Id. This only includes sprints that the user has permission to view.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

boardId

integer

Required

Query parameters

maxResults

integer

state

StringList

startAt

integer

Responses

Returns the requested sprints, at the specified page of the results. Sprints will be ordered first by state (i.e. closed, active, future) then by their position in the backlog.

application/json

SprintBean

GET/agile/1.0/board/{boardId}/sprint

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/sprint' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "activatedDate": "2015-04-11T15:22:00.000+10:00",
  "autoStartStop": true,
  "completeDate": "2015-04-20T11:04:00.000+10:00",
  "endDate": "2015-04-20T01:22:00.000+10:00",
  "goal": "Goal for the sprint",
  "id": 10001,
  "incompleteIssuesDestinationId": 10001,
  "name": "Sprint 1",
  "originBoardId": 5,
  "self": "http://www.example.com/jira/rest/agile/1.0/sprint/10001",
  "startDate": "2015-04-11T15:22:00.000+10:00",
  "state": "active",
  "synced": true
}

GET

Get all issues for a sprint

Get all issues you have access to that belong to the sprint from the board. Issue returned from this resource contains additional fields like: sprint, closedSprints, flagged and epic. Issues are returned ordered by rank. JQL order has higher priority than default rank.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

sprintId

integer

Required

boardId

integer

Required

Query parameters

expand

string

jql

string

maxResults

integer

validateQuery

boolean

fields

array<StringList>

startAt

integer

Responses

Returns the requested issues, at the specified page of the results.

application/json

SprintBean

GET/agile/1.0/board/{boardId}/sprint/{sprintId}/issue

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "activatedDate": "2015-04-11T15:22:00.000+10:00",
  "autoStartStop": true,
  "completeDate": "2015-04-20T11:04:00.000+10:00",
  "endDate": "2015-04-20T01:22:00.000+10:00",
  "goal": "Goal for the sprint",
  "id": 10001,
  "incompleteIssuesDestinationId": 10001,
  "name": "Sprint 1",
  "originBoardId": 5,
  "self": "http://www.example.com/jira/rest/agile/1.0/sprint/10001",
  "startDate": "2015-04-11T15:22:00.000+10:00",
  "state": "active",
  "synced": true
}

GET

Get all versions from a board

Returns all versions from a board, for a given board Id. This only includes versions that the user has permission to view. Note, if the user does not have permission to view the board, no versions will be returned at all. Returned versions are ordered by the name of the project from which they belong and then by sequence defined by user.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

boardId

integer

Required

Query parameters

maxResults

integer

released

string

startAt

integer

Responses

Returns the requested versions, at the specified page of the results.

application/json

VersionBean

GET/agile/1.0/board/{boardId}/version

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/version' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "archived": false,
  "description": "An excellent version",
  "expand": "10000",
  "id": "10000",
  "moveUnfixedIssuesTo": "http://localhost:8090/jira/rest/api/2/version/10000/move",
  "name": "New Version 1",
  "overdue": true,
  "project": "PXA",
  "projectId": 10000,
  "releaseDate": "<string>",
  "releaseDateSet": false,
  "released": true,
  "self": "http://localhost:8090/jira/rest/api/2/version/10000",
  "startDate": "<string>",
  "startDateSet": false,
  "userReleaseDate": "2012-09-15T21:11:01.834+0000",
  "userStartDate": "2012-08-15T21:11:01.834+0000"
}