---
title: "Get customers"
method: GET
path: "/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer"
tags: ["Servicedesk"]
---

# Get customers

`GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer`

## Request

- Base URL: `https://your-domain.atlassian.net`
- URL: `https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer`
- Auth: OAuth 2
  - Authorization code: `https://auth.atlassian.com/authorize`
  - Token URL: `https://auth.atlassian.com/oauth/token` scopes: `manage:servicedesk-customer`

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](#permissions) required**: Permission to view this Service Desk's customers.

## Path parameters

- `serviceDeskId` string, required

## Query parameters

- `query` string
- `start` integer
- `limit` integer

## Response `200`

Returns the service desk's customer list.

- PagedDTOUserDTO
  - `_expands` string[]
  - `_links` PagedLinkDTO
    - `base` string, uri: Base URL for the REST API calls.
    - `context` string
    - `next` string, uri: REST API URL for the next page, if there is one.
    - `prev` string, uri: REST API URL for the previous page, if there is one.
    - `self` string, uri: REST API URL for the current page.
  - `isLastPage` boolean: Indicates if this is the last page of records (true) or not (false).
  - `limit` integer: Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  - `size` integer: Number of items returned in the page.
  - `start` integer: Index of the first item returned in the page.
  - `values` UserDTO[]: Details of the items included in the page.
    - `_links` UserLinkDTO
      - `avatarUrls` object: Links to the various sizes of the customer's avatar. Note that this property is deprecated, and will be removed in future versions.
      - `jiraRest` string, uri: REST API URL for the customer.
      - `self` string, uri
    - `accountId` string: The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
    - `active` boolean: Indicates if the customer is active (true) or inactive (false)
    - `displayName` string: Customer's name for display in a UI. Depending on the customer’s privacy settings, this may return an alternative value.
    - `emailAddress` string: Customer's email address. Depending on the customer’s privacy settings, this may be returned as null.
    - `key` string: This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
    - `name` string: This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
    - `timeZone` string: Customer time zone. Depending on the customer’s privacy settings, this may be returned as null.

## Other responses

- `401`: Returned if the user is not logged in.
- `403`: Returned if the user does not have permission to complete this request.
- `404`: Returned if the service desk does not exist.
- `500`: Internal Server Error.

---

[API](https://skmtc.dev/atlassian/apis/service-management-public-rest-api.md) - [All operations](https://skmtc.dev/atlassian/apis/service-management-public-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/atlassian/apis/service-management-public-rest-api/revisions/fe02b1260fc7?raw)