Get board parameters
Written by
Use this request to get the parameters of an issue board.
Request format
Before making the request, get permission to access the API.
To get the parameters of a specific issue board, use an HTTP GET
request.
GET /v2/boards/<board-id>
Host: https://api.tracker.yandex.net
Authorization: OAuth <token>
X-Org-ID: <organization ID>
Headers
-
Host
API host address:
https://api.tracker.yandex.net
-
Authorization
OAuth token in
OAuth <token value>
format. For example:OAuth 0c4181a7c2cf4521964a72ff57a34a07
-
X-Org-ID
Organization ID.
Resource
Parameter | Description | Data type |
---|---|---|
<board-id> | Board ID | Number |
Response format
Request executed successfully
Request failed
If the request is successful, the API returns a response with code 200 OK
.
The response body contains a JSON object with board parameters.
{
"self" : "https://api.tracker.yandex.net/v2/boards/1",
"id" : 1,
"version" : 1412806202302,
"name" : "Testing",
"columns" :
[
{
"self" : "https://api.tracker.yandex.net/v2/boards/1/columns/1387461731452",
"id" : "1387461731452",
"display": "Open"
},
...
],
"filter": {
"<key of parameter 1>": "<value 1>",
"<key of parameter 2>": [
"<value 2>",
...
],
...
},
"orderBy": "updated",
"orderAsc": false,
"query": "<Parameter 1>: <Value 1> AND <Parameter 2>: <Value 2> OR <Parameter 3>: <Value 3>...",
"useRanking": false,
"estimateBy": {
"self": "https://api.tracker.yandex.net/v2/fields/storyPoints",
"id": "storyPoints",
"display": "Story Points"
},
"country": {
"self": "https://api.tracker.yandex.net/v2/countries/1",
"id": "1",
"display": "Russia"
},
"defaultQueue": {
"self": "https://api.tracker.yandex.net/v2/queues/DOC",
"id": "3",
"key": "DOC",
"display": "Documentation"
},
"calendar": {
"id": 6
}
}
Response parameters
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with board parameters. | String |
id | Board ID. | Number |
version | Board version. Each change to the board increases its version number. | Number |
name | Board name. | String |
columns | Object with information about board columns. | Object |
filter | Object with information about filter conditions used for selecting issues for the board. Issue parameters are made up of fields and values. |
Object |
orderBy | Field key. The field is used as a parameter for sorting board issues. Full list of fields: https://tracker.yandex.com/admin/fields |
String |
orderAsc | Field value sorting order:
|
Boolean |
query | Parameters of the filter used to select issues for the board. The parameters are specified in the query language. |
String |
useRanking | Shows if you can change the order of issues on the board:
|
Object |
estimateBy | Object with information about the parameter that issues on the board are estimated by. Defaults to Story Points . |
Object |
country | Object with information about the country. Data of a country's business calendar is used in the Burndown chart. To get a list of countries, use an HTTP request: GET /v2/countries |
Object |
defaultQueue | Object with information about the default queue for creating issues. | Object |
calendar | Object with information about the business calendar used for the board. The calendar is used to count working and non-working days in the Burndown chart. | Number |
Object fields columns
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the board column | String |
id | Column ID | String |
display | Column name displayed | String |
Object fields filter
Parameter | Description | Data type |
---|---|---|
<key of parameter 1> | Key of the field that is used as a parameter for selecting issues for the board. Full list of fields: https://tracker.yandex.com/admin/fields |
String |
<key of parameter 2> | Array with the keys of the fields that are used as parameters for selecting issues for the board. Full list of fields: https://tracker.yandex.com/admin/fields |
Array |
Object fields estimateBy
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the issue estimation parameter. | String |
id | ID of the issue estimation parameter | String |
display | Issue estimation parameter name displayed. | String |
Object fields country
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with the country name | String |
id | Country ID | String |
display | Country name displayed | String |
Object fields defaultQueue
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the queue | String |
id | Queue ID | String |
key | Queue key | String |
display | Queue name displayed | String |
Object fields calendar
Parameter | Description | Data type |
---|---|---|
id | Calendar ID | Number |
If the request is processed incorrectly, the API returns a response with an error code:
- 400
- One or more request parameters have an invalid value.
- 403
- Insufficient rights to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.
- 404
- The requested object was not found. You may have specified an invalid object ID or key.
- 500
- Internal service error. Try resending your request in a few minutes.
- 503
- The API service is temporarily unavailable.