Get started
Yandex Tracker

Get parameters of all boards

Written by

Use this request to get parameters of all issue boards created by the organization's users.

Request format

To get the parameters of all issue boards, use an HTTP GET request:

GET /v2/boards
Host: https://api.tracker.yandex.net
Authorization: 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 <token value> format. For example:

    OAuth 0c4181a7c2cf4521964a72ff57a34a07

  • X-Org-ID

    Organization ID.

Response format

If the request is successful, the API returns a response with code 200. The response body contains a JSON array with parameters for all boards created by the organization's users.

Response body

[ 
  {
  "self" : "http://api.tracker.yandex.net/v2/boards/1",
  "id" : 1,
  "version" : 1412806202302,
  "name" : "Testing", 
  "columns" : 
  [ 
   {
    "self" : "http://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,

  "country": {
       "self": "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.
Full list of fields: https://tracker.yandex.com/admin/fields		 String
orderAsc Field value sorting order:
  • true: Ascending.
  • false: Descending.
 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:
  • true: Yes.
  • false: No.
 Boolean
country Object with information about the country. Data of a country's business calendar is used in the Burn down chart.
To get a list of countries, use the HTTP GET /v2/countries request.		 Object

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 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

If the request is processed incorrectly, the API returns a message with error details:

HTTP error code Error description
400 Bad Request One of the request parameters has an invalid value or data format.
403 Forbidden The user or application has no access rights to the resource, the request is rejected.
404 Not Found The requested resource not found.
500 Internal Server Error Internal service error. Try again later.
503 Service Unavailable The API service is temporarily unavailable.
In this article: