Creating a board
Use this request to create an issue board.
POST
https://api.tracker.yandex.net/v3/liveBoards
The POST /v3/boards/ method was previously used to create boards. It is deprecated. When you call this method, it creates a board with default settings and ignores the parameters in the request body.
Query format
Before making a request, get permission to access the API.
To create a board, use an HTTP request with the POST method. Specify the parameters in JSON format in the request body.
POST /v3/liveBoards
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
Content-Type: application/json
X-Org-ID or X-Cloud-Org-ID: ORGANIZATION_ID
{
"name": "My board",
"owner": "username",
"columns": [
{
"name": "To Do",
"statuses": ["new", "open"]
},
{
"name": "In Progress",
"statuses": ["inProgress"]
}
]
}
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 Identity Hub organization is linked to Tracker. Learn more
-
-
ID types
X-Org-IDorX-Cloud-Org-ID: Organization ID.-
Use the
X-Org-IDheader if a Tracker organization is linked to Yandex 360 for Business. -
Use the
X-Cloud-Org-IDheader if a Tracker organization is linked to Yandex Identity Hub.
Finding the ID
To get the organization ID, go to Administration → Organizations and copy the value from the ID field.
-
Request body parameters
The request body contains the parameters of the new board.
Required parameters
| Parameter | Description | Data type |
|---|---|---|
| name | Board name | String |
Additional parameters
|
Parameter |
Description |
Data type |
|
owner |
User login or UID |
String or number |
|
boardPermissionsTemplate |
Defines board access permissions:
By default, the board is available to all employees. |
String |
|
backlogAvailable |
Options for enabling the backlog and sprints on the issue board:
|
Boolean |
|
List of board columns |
Array of objects |
|
|
List of additional columns in the backlog. What are backlog columns |
Array of objects |
|
|
List of custom columns that are not associated with issue statuses. What are custom columns |
Array of objects |
|
|
Object with settings for filters that automatically add issues to and remove issues from the board. How to configure adding and removing issues |
Object |
Object fields columns
| Parameter | Description | Data type |
|---|---|---|
| name | Column name | String |
| statuses | List of statuses for issues displayed in the column. You can view status names and keys on the Tracker settings page. |
Array of strings or numbers |
| limit | Maximum number of issues in the column | Number |
Object fields backlogColumns
| Parameter | Description | Data type |
|---|---|---|
| name | Backlog column name | String |
| limit | Maximum number of issues in the column | Number |
Object fields nonParametrizedColumns
| Parameter | Description | Data type |
|---|---|---|
| name | Column name | String |
| limit | Maximum number of issues in the column | Number |
Object fields autoFilters
| Parameter | Description | Data type |
|---|---|---|
| addFilter | Object with settings for a filter that automatically adds issues to the board | Object |
| removeFilter | Object with settings for a filter that automatically removes issues from the board | Object |
Object fields addFilter
|
Parameter |
Description |
Data type |
|
liveFilter |
Contains the nested
You can view the list of existing parameters on the Tracker settings page. For example:
|
Object |
|
enabled |
If the parameter is set to |
Boolean |
Object fields removeFilter
|
Parameter |
Description |
Data type |
|
statuses |
List of statuses that will be the condition for removing issues from the board. |
Array of strings |
|
checkResolutionPresence |
Specifies whether to consider the resolution when removing issues:
|
Boolean |
|
maxTimeInToRemoveState |
The time spent in the specified statuses after which issues are removed, in the For example, |
String |
|
enabled |
If the parameter is set to |
Boolean |
Example 1: Create a board with the following settings:
- name:
Testing;- owner:
username;- sprints and the backlog are enabled.
POST /v3/liveBoards/ Host: api.tracker.yandex.net Authorization: OAuth API_TOKEN Content-Type: application/json X-Org-ID: 1234****** { "name": "Testing", "owner": "username", "backlogAvailable": true, "sprintsAvailable": true }
Example 2: Create a board with the following settings:
- name:
Testing;- a filter is enabled that automatically adds issues with the following parameters: queue with the
DEVkey and assignee with theusernamelogin.POST /v3/liveBoards/ Host: api.tracker.yandex.net Authorization: OAuth API_TOKEN Content-Type: application/json X-Org-ID: 1234****** { "name": "Testing", "autoFilters": { "addFilter": { "liveFilter": { "fieldValues": { "queue": [ { "fixed": "DEV" } ], "assignee": [ { "fixed": "username" } ] } }, "enabled": true } } }
Response format
If the request is successful, the API returns a response with code 201 Created.
The response body contains a JSON object with the parameters of the new board.
{
"self": "https://api.tracker.yandex.net/v3/boards/1",
"id": 1,
"version": 1,
"name": "My board",
"createdAt": "2026-01-22T09:02:18.647+0000",
"updatedAt": "2026-01-22T09:02:18.647+0000",
"createdBy": {
"self": "https://api.tracker.yandex.net/v3/users/112000***",
"id": "username",
"display": "User Name",
"cloudUid": "ajevuhegoggfk*******",
"passportUid": 112000***
},
"columns": [
{
"self": "https://api.tracker.yandex.net/v3/boards/1/columns/1",
"id": "1",
"display": "Open"
},
...
],
"useRanking": false,
"estimateBy": {
"self": "https://api.tracker.yandex.net/v3/fields/storyPoints",
"id": "storyPoints",
"display": "Story Points"
},
"country": {
"self": "https://api.tracker.yandex.net/v3/countries/1",
"id": "1",
"display": "Russia"
},
"calendar": {
"id": 6
}
}
Response parameters
|
Parameter |
Description |
Data type |
|
self |
Address of the API resource that contains the board parameters |
String |
|
id |
Board ID |
Number |
|
version |
Board version. Each board update increases the version number. |
Number |
|
name |
Board name |
String |
|
createdAt |
Board creation date in the |
String |
|
updatedAt |
Date of the last board update in the |
String |
|
Information about the user who created the board |
Object |
|
|
Information about board columns |
Array of objects |
|
|
useRanking |
The parameter is deprecated and does not affect how the board works. Specifies whether you can change the order of issues on the board:
|
Boolean |
|
estimateBy |
The parameter is deprecated and does not affect how the board works. Information about the issue field used to estimate effort |
Object |
|
country |
The parameter is deprecated and does not affect how the board works. Information about the country. |
Object |
|
calendar |
Object that contains the calendar ID. Calendar data is used in the burndown chart. |
Object |
|
Information about filter settings that automatically add issues to and remove issues from the board |
Object |
Object fields createdBy
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource with information about the user | String |
| id | User ID. | String |
| display | Displayed user name | String |
| passportUid | Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID. | Number |
| cloudUid | Unique user ID in Yandex Identity Hub | String |
Object fields columns
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource with information about the issue parameter | String |
| id | Issue parameter ID | String |
| display | Displayed parameter name | String |
Object fields autoFilterSettings
| Parameter | Description | Data type |
|---|---|---|
| addFilterSettings | Object with filter settings for automatically adding issues to the board | Object |
| removeFilterSettings | Object with filter settings for automatically removing issues from the board | Object |
If the request was not processed successfully, 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.
- 422
- JSON validation error, the request is rejected.
- 500
- Internal service error. Try again later.
- 503
- The API service is temporarily unavailable.
An issue board is a visual representation of issues arranged in columns. Each column corresponds to a status, for example