v2

OpenAPI 3.0.12026-08-0174115357.9 KB
Servicedesk

Get customers

This method returns a list of the customers on a service desk.

The returned list of customers can be filtered using the query parameter. The parameter is matched against customers' displayName, name, or email. For example, searching for "John", "Jo", "Smi", or "Smith" will match a user with display name "John Smith".

Permissions required: Permission to view this Service Desk's customers.

get/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer

Path parameters

serviceDeskIdstring required

The ID of the service desk the customer list should be returned from. This can alternatively be a project identifier.

Query parameters

querystring

The string used to filter the customer list.

startinteger

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

limitinteger

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

Response

Returns the service desk's customer list.

_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.