Getting column parameters
Written by
Updated at February 19, 2024
Use this request to get the parameters of a board's column.
Request format
Before making the request, get permission to access the API.
To get the parameters of board columns, use an HTTP GET request.
GET /v2/boards/<board_ID>/columns/<column_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-IDheader is used. - If a Yandex Cloud Organization organization is the only one linked to Tracker, the
X-Cloud-Org-IDheader is used. - If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the
X-Org-IDheader 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
Resource
| Parameter | Description | Data type |
|---|---|---|
| <board_ID> | Board ID | Number |
| <column_ID> | Column 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 column parameters.
{
"self": "https://https://api.tracker.yandex.net/v2/boards/73/columns/1",
"id": 1,
"name": "Open",
"statuses":
[
{
"self": "https://https://api.tracker.yandex.net/v2/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 output in the column. A 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
- 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.