Getting a list of queues

Written by

Yandex Cloud

Updated at February 19, 2024

Request format
Response format

Use this request to get a list of available queues. If there are more than 50 queues in the response, use pagination.

Request format

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

To search for issues, use an HTTP GET request.

GET /v2/queues/
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-ID header is used.
- If a Yandex Cloud Organization organization is the only one linked to Tracker, the X-Cloud-Org-ID header is used.
- If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the X-Org-ID header and the Yandex 360 for Business organization ID are used.

Request parameters

Additional parameters

Parameter	Description	Data type
expand	Additional fields to include in the response. The possible values include: `projects`: Queue projects. `components`: Components. `versions`: Versions. `types`: Issue types. `team`: List of team members. `workflows`: Workflows.	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.

An HTTP GET method is used.
GET /v2/queues HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID: <organization ID>

Response format

If the request is successful, the API returns a response with code 200 OK.

[
  {
    "self": "https://https://api.tracker.yandex.net/v2/queues/TEST",
    "id": "3",
    "key": "TEST",
    "version": 5,
    "name": "Test",
    "description": "Queue created for testing purposes",
    "lead": {
           "self": "https://https://api.tracker.yandex.net/v2/users/11********",
           "id": "11********",
           "display": "Ivan Ivanov"
    },
    "assignAuto": false,
    "defaultType": {
           "self": "https://https://api.tracker.yandex.net/v2/issuetypes/1",
           "id": "1",
           "key": "bug",
           "display": "Error"
    },
    "defaultPriority": {
           "self": "https://https://api.tracker.yandex.net/v2/priorities/3",
           "id": "3",
           "key": "normal",
           "display": "Normal"
    },
    "teamUsers": [
           {
               "self": "https://https://api.tracker.yandex.net/v2/users/11********",
               "id": "11********",
               "display": "Ivan Ivanov"
           },
           ...
    ],
    "issueTypes": [
           {
               "self": "https://https://api.tracker.yandex.net/v2/issuetypes/1",
               "id": "1",
               "key": "bug",
               "display": "Error"
           },
           ...
    ],
    "versions": [
           {
               "self": "https://https://api.tracker.yandex.net/v2/versions/4",
               "id": "4",
               "display": "Peek-a-boo"
        }
    ],
    "workflows": {
           "dev": [
               {
                    "self": "https://https://api.tracker.yandex.net/v2/issuetypes/1",
                    "id": "1",
                    "key": "bug",
                    "display": "Error"
                },
                ...
           ]
    },
    "denyVoting": false,
    "issueTypesConfig": [
           {
               "issueType": {
                      "self": "https://https://api.tracker.yandex.net/v2/issuetypes/1",
                      "id": "1",
                      "key": "bug",
                      "display": "Error"
            },
            "workflow": {
                      "self": "https://https://api.tracker.yandex.net/v2/workflows/dev",
                      "id": "dev",
                      "display": "dev"
            },
            "resolutions": [
                   {
                      "self": "https://https://api.tracker.yandex.net/v2/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	Object
assignAuto	Automatically assign new issues in the queue: `true`: Assign `false`: Do not assign	Logical
defaultType	Block with information about the default issue type	Object
defaultPriority	Block with information about the default issue priority	Object
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	Logical
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	User's name displayed.	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	Object
workflow	Block with information about the issue type workflow	Object
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

Getting a list of queues

Request formatRequest format

Response formatResponse format

Was the article helpful?

Request format

Response format