Returns all boards. This only includes boards that the user has permission to view.
integer
string
string
StringList
integer
Returns the requested boards, at the specified page of the results.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/agile/1.0/board' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Creates a new board. Board name, type and filter Id is required.
Bean which contains board name, type and filter Id.
integer
string
string
Returns the created board.
1
2
3
4
5
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'Returns a single board, for a given board Id.
integer
RequiredReturns the requested board.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/agile/1.0/board/{boardId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Deletes the board.
integer
RequiredReturned if the board has been successfully removed.
1
2
3
curl --request DELETE \
--url 'http://{baseurl}/rest/agile/1.0/board/{boardId}' \
--user 'email@example.com:<api_token>'Returns all issues from a board's backlog, for a given board Id.
integer
Requiredstring
string
integer
boolean
array<StringList>
integer
Returns the requested issues.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/backlog' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Get the board configuration. The response contains the following fields:
integer
RequiredReturns the configuration of the board for given boardId.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/configuration' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'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.
integer
Requiredinteger
string
integer
Returns the requested epics, at the specified page of the results.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/epic' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Returns all issues that do not belong to any epic on a board, for a given board Id.
integer
Requiredstring
string
integer
boolean
array<StringList>
integer
Returns the requested issues, at the specified page of the results.
1
2
3
4
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'Returns all issues that belong to an epic on the board, for the given epic Id and the board Id.
integer
Requiredinteger
Requiredstring
string
integer
boolean
array<StringList>
integer
Returns the requested issues, at the specified page of the results.
1
2
3
4
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'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.
integer
Requiredstring
string
integer
boolean
array<StringList>
integer
Returns the requested issues.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/issue' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'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.
integer
Requiredinteger
integer
Returns the board's projects, at the specified page of the results.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/project' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'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.
string
RequiredReturns the requested property keys.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/properties' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'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.
string
Requiredstring
RequiredReturns the requested property.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/properties/{propertyKey}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'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.
string
Requiredstring
RequiredReturned if the board property is successfully updated.
1
2
3
4
curl --request PUT \
--url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/properties/{propertyKey}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Removes the property from the board identified by the id. Ths user removing the property is required to have permissions to modify the board.
string
Requiredstring
RequiredReturned if the board property was removed successfully.
1
2
3
curl --request DELETE \
--url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/properties/{propertyKey}' \
--user 'email@example.com:<api_token>'Returns the value of the setting for refined velocity chart
integer
RequiredReturned if the board exists and the property was found.
1
2
3
4
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'Sets the value of the specified board's refined velocity setting.
integer
RequiredThe 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.
boolean
Returned if the board property is successfully updated.
1
2
3
4
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'Returns all sprints from a board, for a given board Id. This only includes sprints that the user has permission to view.
integer
Requiredinteger
StringList
integer
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.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/sprint' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'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.
integer
Requiredinteger
Requiredstring
string
integer
boolean
array<StringList>
integer
Returns the requested issues, at the specified page of the results.
1
2
3
4
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'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.
integer
Requiredinteger
string
integer
Returns the requested versions, at the specified page of the results.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/agile/1.0/board/{boardId}/version' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Rate this page: