Get a list of queues

Written by

Request format
Response format
Paginated result output
Possible response codes

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

Request format

To search for issues, use an HTTP POST request:

GET /v2/queues?
&expand=<additional response fields>
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-Id: <organization ID>

Request parameters

expand (optional)

Additional fields to include in the response. Possible values:
- projects: Queue projects.
- components: Components.
- versions: Versions.
- types: Issue types.
- team: List of team members.
- workflows: Workflows.
perPage (optional)

Number of queues on the response page. The default value is 50. Additional parameters for displaying the response can be configured using paging.

Request for a list of issues with additional filtering options:

Use the HTTP GET method.
GET /v2/queues HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-Id: <organization ID>
Cache-Control: no-cache

Response format

[
  {
    "self": "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://api.tracker.yandex.net/v2/users/1120000000016876",
           "id": "<employee ID>",
           "display": "<employee name displayed>"
    },
    "assignAuto": false,
    "defaultType": {
           "self": "https://api.tracker.yandex.net/v2/issuetypes/1",
           "id": "1",
           "key": "bug",
           "display": "Bug"
    },
    "defaultPriority": {
           "self": "https://api.tracker.yandex.net/v2/priorities/3",
           "id": "3",
           "key": "normal",
           "display": "Medium"
    },
    "teamUsers": [
           {
               "self": "https://api.tracker.yandex.net/v2/users/1120000000016876",
               "id": "<employee ID>",
               "display": "<employee name displayed>"
           },
           ...
    ],
    "issueTypes": [
           {
               "self": "https://api.tracker.yandex.net/v2/issuetypes/1",
               "id": "1",
               "key": "bug",
               "display": "Bug"
           },
           ...
    ],
    "versions": [
           {
               "self": "https://api.tracker.yandex.net/v2/versions/4",
               "id": "4",
               "display": "Cuckoo"
        }
    ],
    "workflows": {
           "dev": [
               {
                    "self": "https://api.tracker.yandex.net/v2/issuetypes/1",
                    "id": "1",
                    "key": "bug",
                    "display": "Bug"
                },
                ...
           ]
    },
    "denyVoting": false,
    "issueTypesConfig": [
           {
               "issueType": {
                      "self": "https://api.tracker.yandex.net/v2/issuetypes/1",
                      "id": "1",
                      "key": "bug",
                      "display": "Bug"
            },
            "workflow": {
                      "self": "https://api.tracker.yandex.net/v2/workflows/dev",
                      "id": "dev",
                      "display": "dev"
            },
            "resolutions": [
                   {
                      "self": "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.	String
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.	Boolean
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 indicates if voting for issues is enabled.	Boolean
issueTypesConfig	Array with queue issue settings.	Array of objects

Object fields lead

Parameter	Description	Data type
self	Link to the user.	String
id	User ID.	String
display	User's name displayed.	String

Object fields defaultType

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

Object fields defaultPriority

Parameter	Description	Data type
self	Link to the priority type.	String
id	Priority ID.	String
key	Priority key.	String
display	Priority name displayed.	String

Array object fields teamUsers

Parameter	Description	Data type
self	Link to the user.	String
id	User ID.	String
display	User's name displayed.	String

Array object fields issueTypes

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

Array object fields versions

Parameter	Description	Data type
self	Link to the queue version.	String
id	Version ID.	String
display	Version name displayed.	String

Array object fields workflows

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

Array object fields issueTypesConfig

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

Object fields issueType

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

Object fields workflow

Parameter	Description	Data type
self	Link to the workflow object.	String
id	Workflow ID.	String
display	Workflow name displayed.	String

Array object fields resolutions

Parameter	Description	Data type
self	Link to the resolution object.	String
id	Resolution ID.	String
key	Resolution ID.	String
display	Resolution name displayed.	String

Paginated result output

If more than 50 queues meet the request criteria, you should use the scrolling mechanism to output the results page by page. To enable scrolling, use the following parameters in the request:

perPage (optional)

Number of tickets per page. The default value is 50. The maximum value is 100.
page (optional)

Response page number. The default value is 1.

The response will contain the following headers:

X-Total-Pages

Total number of pages with entries.
X-Total-Count

Total number of entries in the response.

Possible response codes

200: Request executed successfully.