v2

OpenAPI 3.0.12026-08-0174115357.9 KB
Servicedesk

Get queue

This method returns a specific queues in a service desk. To include a customer request count for the queue (in the issueCount field) in the response, set the query parameter includeCount to true (its default is false).

Permissions required: service desk's Agent.

get/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}

Path parameters

serviceDeskIdstring required

ID of the service desk whose queues will be returned. This can alternatively be a project identifier.

queueIdinteger required

ID of the required queue.

Query parameters

includeCountboolean

Specifies whether to include each queue's customer request (issue) count in the response.

Response

Returns the specific queue of the service desk.

fieldsstring[]

Fields returned for each request in the queue.

idstring

ID for the queue.

issueCountinteger

The count of customer requests in the queue.

jqlstring

JQL query that filters reqeusts for the queue.

namestring

Short name for the queue.