Function: getQueues()

function getQueues(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Defined in: src/serviceDesk/api/servicedesk.ts:213

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.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ includeCount?: boolean; limit?: number; serviceDeskId: string; start?: number; }	-
parameters.includeCount?	boolean	Specifies whether to include each queue's customer request (issue) count in the response.
parameters.limit?	number	The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
parameters.serviceDeskId?	string	ID of the service desk whose queues will be returned. This can alternatively be a project identifier.
parameters.start?	number	The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; base?: string; context?: string; next?: string; prev?: string; self?: string; }; isLastPage?: boolean; limit?: number; size?: number; start?: number; values?: object[]; }>