Rate this page:
GET /rest/agile/1.0/board
Returns all boards. This only includes boards that the user has permission to view.
App scope required: READ
integer
The starting index of the returned boards. Base index: 0. See the 'Pagination' section at the top of this page for more details.
int64
integer
The maximum number of boards to return per page. See the 'Pagination' section at the top of this page for more details.
int32
string
Filters results to boards of the specified types. Valid values: scrum, kanban, simple.
string
Filters results to boards that match or partially match the specified name.
string
Filters results to boards that are relevant to a project. Relevance means that the jql filter defined in board contains a reference to a project.
string
string
boolean
Appends private boards to the end of the list. The name and type fields are excluded for security reasons.
boolean
If set to true, negate filters used for querying by location. By default false.
string
Ordering of the results by a given field. If not provided, values will not be sorted. Valid values: name.
string
List of fields to expand for each board. Valid values: admins, permissions.
integer
Filters results to boards that are relevant to a filter. Not supported for next-gen boards.
int64
1 2 3
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/board' \
--header 'Accept: application/json'
Returns the requested boards, at the specified page of the results.
Content type | Value |
---|---|
application/json |
Example response (application/json)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
{
"maxResults": 2,
"startAt": 1,
"total": 5,
"isLast": false,
"values": [
{
"id": 84,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
"name": "scrum board",
"type": "scrum"
},
{
"id": 92,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92",
"name": "kanban board",
"type": "kanban"
}
]
}
GET /rest/agile/1.0/epic/search
Returns searched epics according to provided parameters.
App scope required: READ
integer
The maximum number of returned results.
50
, Format: int32
boolean
Flag that will exclude done epics from the results.
false
string
Text query by which the results should be filtered.
string
Key of a project by which epics will be prioritised (on the top) in the results.
1 2
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/epic/search'
Returned when the search was successful.
A schema has not been defined for this response code.
GET /rest/agile/1.0/project/{projectIdOrKey}/features
App scope required: READ
string
1 2 3
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/project/{projectIdOrKey}/features' \
--header 'Accept: application/json'
200 response
Content type | Value |
---|---|
application/json |
Rate this page: