v2

OpenAPI 3.0.12026-08-0174115357.9 KB

Servicedesk

Get queues

This method returns the queues in a service desk. To include a customer request count for each 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

Path parameters

serviceDeskIdstring required

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

Query parameters

includeCountboolean

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

startinteger

The starting index of the returned objects. Base index: 0. See the Pagination section for more details.

limitinteger

The maximum number of items to return per page. Default: 50. See the Pagination section for more details.

Response

Returns the queues of the service desk, on the specified page of the results.

_expandsstring[]

isLastPageboolean

Indicates if this is the last page of records (true) or not (false).

limitinteger

Number of items to be returned per page, up to the maximum set for these objects in the current implementation.

sizeinteger

Number of items returned in the page.

startinteger

Index of the first item returned in the page.