Get 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 paging.
Request format
To search for issues, use the HTTP GET
method:
GET /v2/queues?
&expand=<additional fields in the response>
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-Id: <organization ID>
- expand (optional)
- Additional fields to include in the response. Possible values:
projects
— Projects in the queue.components
— Components.versions
— Versions.types
— Types of issues.team
— List of team members.workflows
— Workflows.
Request for a list of issues with additional filtering options:
Uses 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",
"lead": {
"self": "https://api.tracker.yandex.net/v2/users/1120000000016876",
"id": "<user ID>",
"display": "<user's display name>"
},
"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": "Normal"
},
"teamUsers": [
{
"self": "https://api.tracker.yandex.net/v2/users/1120000000016876",
"id": "<user ID>",
"display": "<user's display name>"
},
...
],
"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": "Kuku"
}
],
"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": "Do not fix"
},
...
] }, ... ] }, ...]
Parameter | Description | Data type |
---|---|---|
self | Reference to the queue. | String. |
id | The queue ID. | String. |
key | The queue key. | String. |
version | Queue version. Each change to the queue increments the version number. | Integer. |
name | The name of the queue. | String. |
description | Text description of the queue. | String. |
lead | A section with information about the queue owner. | Object. |
assignAuto | Indicates whether the assignee is set automatically for new issues that are created in the queue. | Boolean. |
defaultType | A section with information about the default type for issues in the queue. | Object. |
defaultPriority | A section with information about the default priority for issues in the queue. | Object. |
teamUsers | An array with information about members of the queue team. | Array of objects. |
issueTypes | An array with information about the types of issues in the queue. | Array of objects. |
versions | An array with information about versions of the queue. | Array of objects. |
workflows | A list of queue workflows and their issue types. | Array. |
denyVoting | Indicates whether voting is available for the issue. | Boolean. |
issueTypesConfig | Array with settings for issues in the queue. | Array of objects. |
Fields for the lead object | ||
self | Reference to the Tracker user. | String. |
id | User ID. | String. |
display | Display name of the user. | String. |
Fields for the defaultType object | ||
self | Reference to the type of issue. | String. |
id | ID of the issue type. | String. |
key | Key of the issue type. | String. |
display | Display name of the issue type. | String. |
Fields for the defaultPriority object | ||
self | Reference to the priority type. | String. |
id | Priority ID. | String. |
key | Priority key. | String. |
display | Display name of the priority. | String. |
Fields for objects in the teamUsers array | ||
self | Reference to the Tracker user. | String. |
id | User ID. | String. |
display | Display name of the user. | String. |
Fields for objects in the issueTypes array | ||
self | Reference to the type of issue. | String. |
id | ID of the issue type. | String. |
key | Key of the issue type. | String. |
display | Display name of the issue type. | String. |
Fields for objects in the versions array | ||
self | Reference to the queue version. | String. |
id | Version ID. | String. |
display | Display name of the version. | String. |
Fields for objects in the workflows array | ||
self | Reference to the type of issue. | String. |
id | ID of the issue type. | String. |
key | Key of the issue type. | String. |
display | Display name of the issue type. | String. |
Fields for objects in the issueTypesConfig array | ||
issueType | A section with information about the type of issue. | Object. |
workflow | A block with information about the workflow for this issue type. | Object. |
resolutions | Array with possible resolutions for this issue type. | Array of objects. |
Fields for the issueType object | ||
self | Reference to the type of issue. | String. |
id | ID of the issue type. | String. |
key | Key of the issue type. | String. |
display | Display name of the issue type. | String. |
Fields for the workflow object | ||
self | Reference to the workflow object. | String. |
id | Workflow ID. | String. |
display | Display name of the workflow. | String. |
Fields for objects in the resolutions array | ||
self | Reference to the resolution object. | String. |
id | Resolution ID. | String. |
key | Resolution ID. | String. |
display | Display name of the resolution. | String. |
Parameter | Description | Data type |
---|---|---|
self | Reference to the queue. | String. |
id | The queue ID. | String. |
key | The queue key. | String. |
version | Queue version. Each change to the queue increments the version number. | Integer. |
name | The name of the queue. | String. |
description | Text description of the queue. | String. |
lead | A section with information about the queue owner. | Object. |
assignAuto | Indicates whether the assignee is set automatically for new issues that are created in the queue. | Boolean. |
defaultType | A section with information about the default type for issues in the queue. | Object. |
defaultPriority | A section with information about the default priority for issues in the queue. | Object. |
teamUsers | An array with information about members of the queue team. | Array of objects. |
issueTypes | An array with information about the types of issues in the queue. | Array of objects. |
versions | An array with information about versions of the queue. | Array of objects. |
workflows | A list of queue workflows and their issue types. | Array. |
denyVoting | Indicates whether voting is available for the issue. | Boolean. |
issueTypesConfig | Array with settings for issues in the queue. | Array of objects. |
Fields for the lead object | ||
self | Reference to the Tracker user. | String. |
id | User ID. | String. |
display | Display name of the user. | String. |
Fields for the defaultType object | ||
self | Reference to the type of issue. | String. |
id | ID of the issue type. | String. |
key | Key of the issue type. | String. |
display | Display name of the issue type. | String. |
Fields for the defaultPriority object | ||
self | Reference to the priority type. | String. |
id | Priority ID. | String. |
key | Priority key. | String. |
display | Display name of the priority. | String. |
Fields for objects in the teamUsers array | ||
self | Reference to the Tracker user. | String. |
id | User ID. | String. |
display | Display name of the user. | String. |
Fields for objects in the issueTypes array | ||
self | Reference to the type of issue. | String. |
id | ID of the issue type. | String. |
key | Key of the issue type. | String. |
display | Display name of the issue type. | String. |
Fields for objects in the versions array | ||
self | Reference to the queue version. | String. |
id | Version ID. | String. |
display | Display name of the version. | String. |
Fields for objects in the workflows array | ||
self | Reference to the type of issue. | String. |
id | ID of the issue type. | String. |
key | Key of the issue type. | String. |
display | Display name of the issue type. | String. |
Fields for objects in the issueTypesConfig array | ||
issueType | A section with information about the type of issue. | Object. |
workflow | A block with information about the workflow for this issue type. | Object. |
resolutions | Array with possible resolutions for this issue type. | Array of objects. |
Fields for the issueType object | ||
self | Reference to the type of issue. | String. |
id | ID of the issue type. | String. |
key | Key of the issue type. | String. |
display | Display name of the issue type. | String. |
Fields for the workflow object | ||
self | Reference to the workflow object. | String. |
id | Workflow ID. | String. |
display | Display name of the workflow. | String. |
Fields for objects in the resolutions array | ||
self | Reference to the resolution object. | String. |
id | Resolution ID. | String. |
key | Resolution ID. | String. |
display | Display name of the resolution. | String. |
Paginated results
If more than 50 queues meet the request criteria, you will need to use the scrolling mechanism to view the results page by page. For scrolling, use the following parameters in the request:
- perPage (optional)
-
Number of tickets per page. The default value is 50 and the maximum value is 100.
- page (optional)
-
The page number of the response. The default is 1.
The response will contain the following headers:
- X-Total-Pages
- Total number of pages with records.
- X-Total-Count
- The total number of records in the response.
Possible response codes
- 200
- The request was successful.