Getting a list of queues
Use this request to get a list of available queues. If there are more than 50 queues in the response, use pagination.
GET
https://api.tracker.yandex.net/v3/queues/
Query format
Before making a request, get permission to access the API.
To search for issues, use an HTTP GET request.
GET /v3/queues/
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-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 Cloud Organization.
To get the organization ID, go to Administration → Organizations and copy the value from the ID field.
-
Request parameters
Additional parameters
| Parameter | Description | Data type |
|---|---|---|
| expand | Additional fields to include in the response The possible values include:
|
String |
| perPage | Number of queues per response page. The default value is 50. To set up additional response output parameters, use pagination. | Integer |
Example: Get a list of issues with additional filtering options.
- HTTP
GETmethod is used.GET https://api.tracker.yandex.net/v3/queues
Response format
If the request is successful, the API returns a response with code 200 OK.
[
{
"self": "https://api.tracker.yandex.net/v3/queues/TEST",
"id": "3",
"key": "TEST",
"version": 5,
"name": "Test",
"description": "Queue created for testing purposes",
"lead": {
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Ivan Ivanov"
},
"assignAuto": false,
"defaultType": {
"self": "https://api.tracker.yandex.net/v3/issuetypes/1",
"id": "1",
"key": "bug",
"display": "Error"
},
"defaultPriority": {
"self": "https://api.tracker.yandex.net/v3/priorities/3",
"id": "3",
"key": "normal",
"display": "Normal"
},
"teamUsers": [
{
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Ivan Ivanov"
},
...
],
"issueTypes": [
{
"self": "https://api.tracker.yandex.net/v3/issuetypes/1",
"id": "1",
"key": "bug",
"display": "Error"
},
...
],
"versions": [
{
"self": "https://api.tracker.yandex.net/v3/versions/4",
"id": "4",
"display": "Peek-a-boo"
}
],
"workflows": {
"dev": [
{
"self": "https://api.tracker.yandex.net/v3/issuetypes/1",
"id": "1",
"key": "bug",
"display": "Errror"
},
...
]
},
"denyVoting": false,
"issueTypesConfig": [
{
"issueType": {
"self": "https://api.tracker.yandex.net/v3/issuetypes/1",
"id": "1",
"key": "bug",
"display": "Error"
},
"workflow": {
"self": "https://api.tracker.yandex.net/v3/workflows/dev",
"id": "dev",
"display": "dev"
},
"resolutions": [
{
"self": "https://api.tracker.yandex.net/v3/resolutions/2",
"id": "2",
"key": "wontFix",
"display": "Won't fix"
},
...
]
},
...
]
},
...
]
Response parameters
| Parameter | Description | Data type |
|---|---|---|
| self | Queue link. | String |
| id | Queue ID. | Number in string format |
| key | Queue key. | String |
| version | Queue version. Each change to the queue increases its version number. | Number |
| name | Queue name | String |
| description | Text description of the queue | String |
| lead | Block with information about the queue owner | Map item |
| assignAuto | Automatically assign new issues in the queue:
|
Boolean |
| defaultType | Block with information about the default issue type | Map item |
| defaultPriority | Block with information about the default issue priority | Map item |
| teamUsers | Array with information about queue team members | Array of objects |
| issueTypes | Array with information about queue issue types | Array of objects |
| versions | Array with information about queue versions | Array of objects |
| workflows | List of queue workflows and their issue types | Array |
| denyVoting | Flag that shows whether voting for issues is enabled | Boolean |
| issueTypesConfig | Array with queue issue settings | Array of objects |
| 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 Cloud Organization | String |
defaultType object fields
| Parameter | Description | Data type |
|---|---|---|
| self | Link to the issue type | String |
| id | ID of the issue type | String |
| key | Key of the issue type | String |
| display | Issue type name displayed | String |
defaultPriority object fields
| Parameter | Description | Data type |
|---|---|---|
| self | Link to the priority type | String |
| id | Priority ID | String |
| key | Priority key | String |
| display | Priority name displayed | String |
teamUsers array object fields
| Parameter | Description | Data type |
|---|---|---|
| self | Link to the user | String |
| id | User ID | String |
| display | User name displayed | String |
issueTypes array object fields
| Parameter | Description | Data type |
|---|---|---|
| self | Link to the issue type | String |
| id | ID of the issue type | String |
| key | Key of the issue type | String |
| display | Issue type name displayed | String |
versions array object fields
| Parameter | Description | Data type |
|---|---|---|
| self | Link to the queue version | String |
| id | Version ID | String |
| display | Version name displayed | String |
workflows array object fields
| Parameter | Description | Data type |
|---|---|---|
| self | Link to the issue type | String |
| id | ID of the issue type | String |
| key | Key of the issue type | String |
| display | Issue type name displayed | String |
issueTypesConfig array object fields
| Parameter | Description | Data type |
|---|---|---|
| issueType | Block with information about the issue type | Map item |
| workflow | Block with information about the issue type workflow | Map item |
| resolutions | Array with possible issue type resolutions | Array of objects |
issueType object fields
| Parameter | Description | Data type |
|---|---|---|
| self | Link to the issue type | String |
| id | ID of the issue type | String |
| key | Key of the issue type | String |
| display | Issue type name displayed | String |
workflow object fields
| Parameter | Description | Data type |
|---|---|---|
| self | Link to the workflow object | String |
| id | Workflow ID | String |
| display | Workflow name displayed | String |
resolutions array object fields
| Parameter | Description | Data type |
|---|---|---|
| self | Link to the resolution object | String |
| id | Resolution ID | String |
| key | Resolution ID | String |
| display | Resolution name displayed | String |