Contact UsGet started

Getting board parameters

Written by
Updated at February 19, 2024

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 <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.
Resource
Parameter Description Data type
<board_ID> Board ID Number

Response format

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://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,
   "estimateBy": {
      "self": "https://https://api.tracker.yandex.net/v2/fields/storyPoints",
      "id": "storyPoints",
      "display": "Story Points"
    },
   "country": {
      "self": "https://https://api.tracker.yandex.net/v2/countries/1",
      "id": "1",
      "display": "Russia"
    },
   "defaultQueue": {
      "self": "https://https://api.tracker.yandex.net/v2/queues/DOC",
      "id": "3",
      "key": "DOC",
      "display": "Documenting"
    },
    "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.
The full list of fields: https://tracker.yandex.com/admin/fields		 String
orderAsc Sort direction:
  • true: Ascending
  • false: Descending
 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:
  • true: Yes
  • false: No.
 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 Burn down chart.
To get a list of countries, use the HTTP GET /v2/countries request.		 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

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

estimateBy object fields

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

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

defaultQueue object fields

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

calendar object fields

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.
Previous
Getting parameters of all boards
Next
Creating a board