---
title: "Find users for picker"
method: GET
path: "/rest/api/2/user/picker"
tags: ["User search"]
---

# Find users for picker

`GET /rest/api/2/user/picker`

Returns a list of users whose attributes match the query term. The returned object includes the `html` field where the matched query term is highlighted with the HTML strong tag. A list of account IDs can be provided to exclude users from the results.

This operation takes the users in the range defined by `maxResults`, up to the thousandth user, and then returns only the users from that range that match the query term. This means the operation usually returns fewer users than specified in `maxResults`. To get all the users who match the query term, use [Get all users](#api-rest-api-2-users-search-get) and filter the records in your code.

Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the [Profile visibility overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and calls by users without the required permission return search results for an exact name match only.

## Query parameters

- `query` string, required
- `maxResults` integer
- `showAvatar` boolean
- `exclude` string[]
- `excludeAccountIds` string[]
- `avatarSize` string
- `excludeConnectUsers` boolean

## Response `200`

Returned if the request is successful.

- FoundUsers — The list of users found in a search, including header text (Showing X of Y matching users) and total of matched users.
  - `header` string — Header text indicating the number of users in the response and the total number of users found in the search.
  - `total` integer — The total number of users found in the search.
  - `users` UserPickerUser[]
    - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
    - `accountType` 'atlassian' | 'app' | 'customer' | 'unknown' — The user account type. Can take the following values: * `atlassian` regular Atlassian user account * `app` system account used for Connect applications and OAuth to represent external systems * `customer` Jira Service Desk account representing an external service desk
    - `avatarUrl` string, uri — The avatar URL of the user.
    - `displayName` string — The display name of the user. Depending on the user’s privacy setting, this may be returned as null.
    - `html` string — The display name, email address, and key of the user with the matched query string highlighted with the HTML bold tag.
    - `key` string — This property is no longer available. 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 . See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.

## Other responses

- `400` — Returned if `exclude` and `excludeAccountIds` are provided.
- `401` — Returned if the authentication credentials are incorrect or missing.
- `429` — Returned if the rate limit is exceeded. User search endpoints share a collective rate limit for the tenant, in addition to Jira's normal rate limiting you may receive a rate limit for user search. Please respect the Retry-After header.

---

[API](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api.md) · [All operations](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api/versions/a26541c2f8bd/schema)