Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Getting a list of project queues

Written by
Updated at February 19, 2024

Use this request to get a list of queues whose issues are included in a project.

Request format

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

To get a list of project queues, use an HTTP GET request:

GET /v2/projects/<project_ID>/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.
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:
  • all: All queue parameters.
  • projects: All organization projects.
  • components: Queue components.
  • versions: Queue versions.
  • types: Queue issue types.
  • team: Queue team members.
  • workflows: Queue workflows and their issue types.
  • fields: Required queue fields.
  • notification_fields: Queue issue notification fields.
  • issue_types_config: Queue issue settings.
  • enabled_features: Queue integration settings.
  • signature_settings: Information about the queue mailbox: address, alias, and signature.
 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://https://api.tracker.yandex.net/v2/queues/ORG",
        "id": 1,
        "key": "ORG",
        "version": 6,
        "name": "Default",
        "description": "Default queue description (ORG)",
        "lead": {
            "self": "https://https://api.tracker.yandex.net/v2/users/78********",
            "id": "78********",
            "display": "Tracker robot"
        },
        "assignAuto": false,
        "defaultType": {
            "self": "https://https://api.tracker.yandex.net/v2/issuetypes/2",
            "id": "2",
            "key": "task",
            "display": "Issue"
        },
        "defaultPriority": {
            "self": "https://https://api.tracker.yandex.net/v2/priorities/3",
            "id": "3",
            "key": "normal",
            "display": "Normal"
        },
        "allowExternalMailing": true,
        "addIssueKeyInEmail": true,
        "denyVoting": false,
        "denyConductorAutolink": false,
        "denyTrackerAutolink": true,
        "useComponentPermissionsIntersection": false,
        "useLastSignature": false
    },
    {
        "self": "https://https://api.tracker.yandex.net/v2/queues/TEST",
        "id": 3,
        "key": "TEST",
        "version": 8,
        "name": "Testing",
        "description": "Testing queue description (TEST)",
        "lead": {
            "self": "https://https://api.tracker.yandex.net/v2/users/12********",
            "id": "12********",
            "display": "Full Name"
        },
        "assignAuto": true,
        "defaultType": {
            "self": "https://https://api.tracker.yandex.net/v2/issuetypes/2",
            "id": "2",
            "key": "task",
            "display": "Issue"
        },
        "defaultPriority": {
            "self": "https://https://api.tracker.yandex.net/v2/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 Object
assignAuto Flag indicating that new issues in the queue are assigned automatically:
  • true: Assign.
  • false: don't assign.
 Logical
defaultType Block with information about the default issue type Object
defaultPriority Block with information about the default issue priority Object
allowExternalMailing Flag that indicates if emails to external addresses are allowed:
  • true: Enable.
  • false: Disable.
 Logical
addIssueKeyInEmail Flag that indicates if the issue number is added to the email subject:
  • true: Add.
  • false: Do not add.
 Logical
denyVoting Flag that indicates if voting for issues is allowed:
  • true: Voting disabled.
  • false: Voting enabled.
Logical
denyConductorAutolink Service parameter Logical
denyTrackerAutolink Flag that indicates whether to add an automatic link to issues in other queues:
  • true —add a link;
  • false: do not add a link if the key of an issue from another queue is added to the comment or description.
 Logical
useComponentPermissionsIntersection The method of getting access rights to issues with multiple components:
  • true: as an overlap of component access rights;
  • false: as a combination of component access rights.
 Logical
useLastSignature Service parameter Logical

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 isn't authorized. Make sure to perform the actions described in API access.
403
Insufficient rights 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.
Previous
Getting a list of all projects
Next
Updating a project