Getting a list of project queues
Use this request to get a list of queues whose issues are included in a project.
GET
https://api.tracker.yandex.net/v3/projects/<project_ID>/queues
Query format
Before making a request, get permission to access the API.
To get a list of project queues, use an HTTP GET
request:
GET /v3/projects/<project_ID>/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-ID
orX-Cloud-Org-ID
: Organization ID.-
Use the
X-Org-ID
header if a Tracker organization is linked to Yandex 360 for Business. -
Use the
X-Cloud-Org-ID
header 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.
-
Resource
Parameter | Description | Data type |
---|---|---|
<project_ID> | Project ID | Number |
Request parameters
Additional parameters
Parameter | Description | Data type |
---|---|---|
expand | Additional fields to include in the response If there are multiple queues in the project, parameters are displayed for each queue:
|
String |
Response format
If the request is successful, the API returns a response with code 200 OK
.
The response body contains information about the project in JSON format.
[
{
"self": "https://api.tracker.yandex.net/v3/queues/ORG",
"id": 1,
"key": "ORG",
"version": 6,
"name": "Default",
"description": "Default queue description (ORG)",
"lead": {
"self": "https://api.tracker.yandex.net/v3/users/78********",
"id": "78********",
"display": "Tracker robot"
},
"assignAuto": false,
"defaultType": {
"self": "https://api.tracker.yandex.net/v3/issuetypes/2",
"id": "2",
"key": "task",
"display": "Issue"
},
"defaultPriority": {
"self": "https://api.tracker.yandex.net/v3/priorities/3",
"id": "3",
"key": "normal",
"display": "Normal"
},
"allowExternalMailing": true,
"addIssueKeyInEmail": true,
"denyVoting": false,
"denyConductorAutolink": false,
"denyTrackerAutolink": true,
"useComponentPermissionsIntersection": false,
"useLastSignature": false
},
{
"self": "https://api.tracker.yandex.net/v3/queues/TEST",
"id": 3,
"key": "TEST",
"version": 8,
"name": "Testing",
"description": "Testing queue description (TEST)",
"lead": {
"self": "https://api.tracker.yandex.net/v3/users/12********",
"id": "12********",
"display": "Full name"
},
"assignAuto": true,
"defaultType": {
"self": "https://api.tracker.yandex.net/v3/issuetypes/2",
"id": "2",
"key": "task",
"display": "Issue"
},
"defaultPriority": {
"self": "https://api.tracker.yandex.net/v3/priorities/3",
"id": "3",
"key": "normal",
"display": "Normal"
},
"allowExternalMailing": false,
"addIssueKeyInEmail": false,
"denyVoting": false,
"denyConductorAutolink": false,
"denyTrackerAutolink": false,
"useComponentPermissionsIntersection": false,
"useLastSignature": false
}
]
Response parameters
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the queue. | String |
id | Queue ID. | Number |
key | Queue key. | String |
version | Queue version. Each change to the queue increases its version number. | String |
name | Queue name | String |
description | Text description of the queue | String |
lead | Block with information about the queue owner | Map item |
assignAuto | Flag indicating that new issues in the queue are assigned automatically:
|
Boolean |
defaultType | Block with information about the default issue type | Map item |
defaultPriority | Block with information about the default issue priority | Map item |
allowExternalMailing | Flag that indicates if emails to external addresses are allowed:
|
Boolean |
addIssueKeyInEmail | Flag that indicates if the issue number is added to the email subject:
|
Boolean |
denyVoting | Flag that indicates if voting for issues is allowed:
|
Boolean |
denyConductorAutolink | Service parameter | Boolean |
denyTrackerAutolink | Flag that indicates whether to add an automatic link to issues in other queues:
|
Boolean |
useComponentPermissionsIntersection | The method of getting access rights to issues with multiple components:
|
Boolean |
useLastSignature | Service parameter | Boolean |
lead
object fields
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the user | String |
id | User ID. | Number |
display | Displayed user name | String |
defaultType
object fields
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the issue type. | String |
id | Issue type ID | Number |
key | Issue type key. | String |
display | Issue type name displayed. | String |
defaultPriority
object fields
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the issue priority. | String |
id | Issue priority ID. | Number |
key | Issue priority key. | String |
display | Issue priority name displayed. | String |
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.
- 401
- The user is not authorized. Make sure that actions described in the API access section are performed.
- 403
- You are not authorized 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.