Find users for picker

GET

/rest/api/3/user/picker

User search

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 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 for more details.

This operation can be accessed anonymously.

Permissions required: Browse users and groups global permission. Anonymous calls and calls by users without the required permission return search results for an exact name match only.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/user/picker?query='

Response Example

200 - Success

{
  "users": [
    {
      "accountId": "5b10a2844c20165700ede21g",
      "accountType": "atlassian",
      "name": "mia",
      "key": "mia",
      "html": "<strong>Mi</strong>a Krystof - <strong>mi</strong>a@example.com (<strong>mi</strong>a)",
      "displayName": "Mia Krystof",
      "avatarUrl": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16"
    }
  ],
  "total": 25,
  "header": "Showing 20 of 25 matching groups"
}

Request

Query Params

query

string

required

A query string that is matched against user attributes, such as displayName, and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com.

maxResults

integer

optional

The maximum number of items to return. The total number of matched users is returned in total.

showAvatar

string

optional

Include the URI to the user's avatar.

exclude

array[string]

optional

This parameter is no longer available. See the deprecation notice for details.

excludeAccountIds

array[string]

optional

A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5. Cannot be provided with exclude.

avatarSize

string

optional

excludeConnectUsers

string

optional

Responses

🟢200Returned if the request is successful.

application/json

Body

The list of users found in a search, including header text (Showing X of Y matching users) and total of matched users.

header

string

optional

Header text indicating the number of users in the response and the total number of users found in the search.

total

integer <int32>

optional

The total number of users found in the search.

users

array[object (UserPickerUser) {6}]

optional

accountId

string

optional

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

avatarUrl

string <uri>

optional

The avatar URL of the user.

displayName

string

optional

The display name of the user. Depending on the user’s privacy setting, this may be returned as null.

html

string

optional

The display name, email address, and key of the user with the matched query string highlighted with the HTML bold tag.

key

string

optional

This property is no longer available. See the deprecation notice for details.

name

string

optional

This property is no longer available . See the deprecation notice for details.

🟠400Returned if `exclude` and `excludeAccountIds` are provided.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠429Returned 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.

Modified at 2023-07-13 03:27:27

Find users with permissions

Find users