Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Blog
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
Yandex Tracker
  • Getting started
    • Activating Yandex Tracker
    • Logging in to Yandex Tracker
    • Adding users
    • Configuring access to Yandex Tracker
    • Setting up Yandex Tracker
    • Working with Yandex Tracker
      • Start page
      • My issues
      • Working with issues
      • Favorite issues, boards, and dashboards
      • Personal settings
    • Migrating to Yandex Tracker
    • Disabling paid services
  • Yandex Tracker mobile app
  • Tutorials
    • Setting up Yandex Tracker for a development team
      • Overview
      • Creating a queue for a development team
      • Structuring issues
      • Using Agile methodologies
      • Configuring issue templates
      • Connecting repositories
      • Automating recurring actions
      • Integrating Yandex Tracker with other platforms
    • Setting up Yandex Tracker for a support team
      • Overview
      • Creating a queue for the support team
      • Accepting requests by mail and via forms
      • Configuring multi-tiered support
      • Sending emails from the issue page
      • Grouping requests by topic
      • Tracking the time it takes to process a request
      • Collecting request statistics
      • Configuring integration with third-party platforms
  • Concepts
    • Service overview
    • Concepts
    • Roles and access rights
  • Configuring queues
    • Overview
    • Create a queue
    • Queue templates
    • Viewing issues in a queue
    • Changing basic queue settings
    • Changing basic queue settings
      • Overview
      • Configuring issue types
      • Creating a workflow
      • Setting up statuses
      • Configuring transitions
      • Setting up resolutions
    • Local issue fields
    • Adding a queue team
    • Setting access rights for queues
    • Advanced queue features
    • Viewing the history of queue changes
    • Delete a queue
  • Working with issues
    • Create an issue
      • Overview
      • Creating an issue via email
      • Creating an issue from a form
      • Cloning an issue
    • Edit an issue
      • Overview
      • Adding comments to issues
      • Creating a checklist
      • Editing issue links
      • Attaching images and files to an issue
      • Formatting text in issues
      • Voting for an issue
      • Move an issue to another queue
      • Changing multiple issues
    • Setting up an issue reminder
    • Registering time spent
    • Adding issue fields
    • Viewing the history of issue changes
    • Getting access to an issue
    • Deleting an issue
  • Structuring issues
    • Overview
    • Links between issues
    • Projects
      • Overview
      • Create a project
      • List of project issues
      • Gantt chart
    • Components
    • Versions
  • Agile development tools
    • Overview
    • Create a board
    • Working with an agile board
    • Editing or deleting a board
    • Backlog
    • Sprints
    • Epics
    • Collaborative workload estimation
    • Burn down charts
  • Issue boards (beta)
    • Overview
    • Create a board
    • Working with an agile board
    • Setting up a board
  • Find issues
    • Finding issues by key or name
    • Finding my issues
    • Finding issues in queues
    • Creating an issue filter
    • Query language
  • Notifications and subscriptions
    • Overview
    • Subscribing to notifications
    • Receiving update reports
    • Subscribing other users to queue updates
    • Email notification settings
      • Overview
      • Notifications about your issues
      • Notifications about your subscriptions
    • Sending notifications to mailboxes in your domain
  • Statistics and dashboards
    • Dashboards
      • Overview
      • Creating a dashboard
      • Widgets
      • Editing a dashboard
      • Shared access to dashboards
      • Making a dashboard your start page
    • Queue statistics
    • Gantt chart
  • Automation and templates
    • Overview
    • Triggers
      • Overview
      • Creating triggers
      • Setting trigger conditions
      • Configuring trigger actions
      • Editing and deleting triggers
      • Examples
    • Auto actions
      • Overview
      • Automatic issue updates
      • Scheduled issue creation
      • Editing or deleting auto actions
    • Macros
    • Templates
      • Overview
      • Creating a template in Yandex Forms (beta)
      • Creating a template
      • Editing a template
      • Deleting a template
      • Using shared templates
    • Variables
    • Using a form as a template for creating issues
  • Configuring an SLA for issues
    • Overview
    • Configuring rules
    • Work schedule
  • Integration with other services
    • Email
    • Yandex Forms
    • Yandex Wiki
    • Messengers
      • Overview
      • Slack
      • Telegram
    • Setting up links to external applications
      • Overview
      • Setting up an external application
      • Sending your application data to the Tracker team
  • Developer tools
    • API
    • Python client
    • Connecting repositories
  • Pricing policy
    • Billing
    • Setting up a billing account
    • Paying for services
    • Viewing service usage details
  • API reference
    • Overview
    • API access
    • General query format
    • Issues
      • Get issue parameters
      • Edit an issue
      • Create an issue
      • Moving an issue to another queue
      • Find out the number of issues
      • Search for issues
      • Release scroll view resources
      • Get priorities
      • Get transitions
      • Make a status transition
      • Get the history of issue changes
      • Issue links
        • Link issues
        • Get issue links
        • Remove issue links
    • Checklists
      • Create a checklist or add items to it
      • Get checklist parameters
      • Edit a checklist
      • Delete a checklist
    • Projects
      • Create a project
      • Get project parameters
      • Get a list of all projects
      • Get a list of project queues
      • Edit a project
      • Delete a project
    • Comments
      • Add comment
      • Get issue comments
      • Edit a comment
      • Delete a comment
    • Macros
      • Get queue macros
      • Get a macro
      • Create a macro
      • Edit a macro
      • Delete a macro
    • External links
      • Get a list of external applications
      • Get a list of issue external links
      • Add an external link
      • Delete an external link
    • Attached files
      • Get a list of attached files
      • Download a file
      • Download a thumbnail
      • Attach a file
      • Upload a temporary file
      • Delete a file
    • Queues
      • Create a queue
      • Get queue parameters
      • Get a list of queues
      • Get queue versions
      • Get required fields for the queue
      • Delete a queue
      • Restore a queue
      • Remove a tag from a queue
      • Automation
        • Auto actions
          • Create an auto action
          • Get auto action parameters
        • Triggers
          • Creating a trigger
          • Get trigger parameters
    • Issue boards
      • Get parameters of all boards
      • Get board parameters
      • Create a board
      • Edit a board
      • Delete a board
      • Columns
        • Get parameters of all columns
        • Get column parameters
        • Create a column
        • Edit a column
        • Delete a column
      • Sprints
        • Get all sprints of a board
        • Get a sprint
        • Create a sprint
    • Components
      • Get a list of components
    • Import
      • Import an issue
      • Import files
      • Import comments
      • Import links
    • Bulk operations
      • Perform a bulk move of issues to a different queue
      • Bulk changes to issues
      • Make bulk changes to issue statuses
    • Time tracking
      • Add a record of time spent
      • Edit a record of time spent
      • Delete a record of time spent
      • Get records of time spent
        • Get all records for an issue
        • Select records by parameters
    • Issue fields
      • Get global issue fields
      • Create an issue field
      • Get issue field parameters
      • Edit issue field names
      • Edit possible values of issue fields
      • Create an issue field category
      • Local fields
        • Create a local queue field
        • Get local queue fields
        • Get information about a local queue field
        • Edit a local queue field
    • Get information about the current user
    • Possible response codes
  • Questions and answers
    • General questions
    • Billing
  • Revision history
    • November 2022
    • October 2022
    • September 2022
    • August 2022
  • Support
  1. API reference
  2. Issue boards
  3. Get board parameters

Get board parameters

Written by
Yandex Cloud
  • Request format
  • Response format

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 <token>
X-Org-ID: <organization ID>
Headers
  • Host

    API host address:

    https://api.tracker.yandex.net
    
  • Authorization

    OAuth token in OAuth <token value> format. For example:

    OAuth 0c4181a7c2cf4521964a72ff57a34a07
    
  • X-Org-ID

    Organization ID.

Resource
Parameter Description Data type
<board-id> Board 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 board parameters.

{
  "self" : "https://api.tracker.yandex.net/v2/boards/1",
  "id" : 1,
  "version" : 1412806202302,
  "name" : "Testing",
  "columns" :
  [
   {
    "self" : "https://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,
   "estimateBy": {
      "self": "https://api.tracker.yandex.net/v2/fields/storyPoints",
      "id": "storyPoints",
      "display": "Story Points"
    }, 
   "country": {
      "self": "https://api.tracker.yandex.net/v2/countries/1",
      "id": "1",
      "display": "Russia"
    },
   "defaultQueue": {
      "self": "https://api.tracker.yandex.net/v2/queues/DOC",
      "id": "3",
      "key": "DOC",
      "display": "Documentation"
    },
    "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.
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.
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 Burndown chart.
To get a list of countries, use an HTTP request: GET /v2/countries
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

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 estimateBy

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

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

Object fields defaultQueue

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

Object fields calendar

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.

Was the article helpful?

Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
In this article:
  • Request format
  • Response format