getCustomers method

Future<PagedDTOUserDTO> getCustomers({
  1. required String serviceDeskId,
  2. String? query,
  3. int? start,
  4. int? limit,
})

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.

Implementation

Future<PagedDTOUserDTO> getCustomers(
    {required String serviceDeskId,
    String? query,
    int? start,
    int? limit}) async {
  return PagedDTOUserDTO.fromJson(await _client.send(
    'get',
    'rest/servicedeskapi/servicedesk/{serviceDeskId}/customer',
    pathParameters: {
      'serviceDeskId': serviceDeskId,
    },
    queryParameters: {
      if (query != null) 'query': query,
      if (start != null) 'start': '$start',
      if (limit != null) 'limit': '$limit',
    },
  ));
}