Getting parameters of all columns

Use this request to get parameters of all columns of a board.

GET

https://api.tracker.yandex.net/v3/boards/<board_ID>/columns

Query format

Before making a request, get permission to access the API.

To get the parameters of all columns for a board, use an HTTP GET request.

GET /v3/boards/<board_ID>/columns
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
Headers

  • Host: Address of the node that provides the API.

  • Authorization: Authorization token about these formats:

    • OAuth <OAuth_token>: For authorization using the OAuth 2.0 protocol. Learn more

    • Bearer <IAM_token>: For authorization using an IAM token, if a Yandex Cloud Organization organization is linked to Tracker. Learn more

  • X-Org-ID or X-Cloud-Org-ID: Organization ID.

    • Use the X-Org-ID header if a Tracker organization is linked to Yandex 360 for Business.

    • Use the X-Cloud-Org-ID header if a Tracker organization is linked to Yandex Cloud Organization.

    To get the organization ID, go to Administration → Organizations and copy the value from the ID field.

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 array with the parameters of all board columns.

[
    {
      "self": "https://api.tracker.yandex.net/v3/boards/73/columns/1",
      "id": 1,
      "name": "Open",
      "statuses":
       [
          {
              "self": "https://api.tracker.yandex.net/v3/statuses/1",
              "id": "1",
              "key": "open",
              "display": "Open"
          },
           ...
       ]
    },
     ...
]
Response parameters
Parameter Description Data type
self Address of the API resource with information about the board column String
id Column ID Number
name Column name String
statuses The array contains the keys of possible statuses of issues to be included in the column.
The list of all issue statuses: https://tracker.yandex.com/admin/statuses		 Array

statuses object fields

Parameter Description Data type
self Address of the API resource with information about the status. String
id Status ID. String
key Status key. String
display Status 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
You are not authorized 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 again later.
503
The API service is temporarily unavailable.
Previous
Deleting a board
Next
Getting column parameters