Getting parameters of all boards
The request enables you to get parameters of all issue boards created by the organization users.
Request format
Before making the request, get permission to access the API.
To get the parameters of all issue boards, use an HTTP GET
request.
GET /v2/boards
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>
Headers
-
Host
Address of the node that provides the API:
https://api.tracker.yandex.net
-
Authorization
OAuth token in
OAuth <OAuth_token>
format, e.g.:OAuth 0c4181a7c2cf4521964a72ff********
-
X-Org-ID or X-Cloud-Org-ID
Organization ID. You can find it out on the Tracker organizations page
.- If a Yandex 360 for Business organization is the only one linked to Tracker, the
X-Org-ID
header is used. - If a Yandex Cloud Organization organization is the only one linked to Tracker, the
X-Cloud-Org-ID
header is used. - If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the
X-Org-ID
header and the Yandex 360 for Business organization ID are used.
- If a Yandex 360 for Business organization is the only one linked to Tracker, the
Response format
If the request is successful, the API returns a response with code 200 OK
.
The response body contains a JSON array with parameters for all boards created by the organization's users.
[
{
"self" : "https://https://api.tracker.yandex.net/v2/boards/1",
"id" : 1,
"version" : 1412806202302,
"name" : "Testing",
"columns" :
[
{
"self" : "https://https://api.tracker.yandex.net/v2/boards/1/columns/13874********",
"id" : "13874********",
"display" : "Open"
},
...
],
"filter": {
"<parameter_1_key>": "<value_1>",
"<parameter_2_key>": [
"<value_2>",
...
],
...
},
"orderBy": "updated",
"orderAsc": false,
"query": "<parameter_1>: <value_1> AND <parameter_2>: <value_2> OR <parameter_3>: <value_3>...",
"useRanking": false,
"country": {
"self": "https://https://api.tracker.yandex.net/v2/countries/1",
"id": "1",
"display": "Russia"
}
},
...
]
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. The full list of fields: https://tracker.yandex.com/admin/fields |
String |
orderAsc | Sort direction:
|
Logical |
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:
|
Logical |
country | Object with information about the country. Data of a country-specific business calendar is used in the burndown chart. To get a list of countries, use the HTTP GET /v2/countries request |
Object |
columns
object fields
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 |
filter
object fields
Parameter | Description | Data type |
---|---|---|
<parameter_1_key> | Key of the field that is used as a parameter for selecting issues for the board. The full list of fields: https://tracker.yandex.com/admin/fields |
String |
<parameter_2_key> | Array with the keys of the fields that are used as parameters for selecting issues for the board. The full list of fields:https://tracker.yandex.com/admin/fields |
Array |
country
object fields
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with the country name | String |
id | Country ID | String |
display | Country name displayed | String |
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.