Find Users For Picker
GET {{baseUrl}}/rest/api/3/user/picker?query=<string>&maxResults=50&showAvatar=false&exclude=<string>&exclude=<string>&excludeAccountIds=<string>&excludeAccountIds=<string>&avatarSize=<string>&excludeConnectUsers=false
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.
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 Params
| Key | Datatype | Required | Description |
|---|---|---|---|
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 | number | The maximum number of items to return. The total number of matched users is returned in total. | |
showAvatar | boolean | Include the URI to the user's avatar. | |
exclude | string | This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. | |
exclude | string | This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. | |
excludeAccountIds | string | 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. | |
excludeAccountIds | string | 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 | ||
excludeConnectUsers | boolean |
RESPONSES
status: OK
{"users":[{"accountId":"5b10a2844c20165700ede21g","accountType":"atlassian","name":"mia","key":"mia","html":"\u003cstrong\u003eMi\u003c/strong\u003ea Krystof - \u003cstrong\u003emi\u003c/strong\u003ea@example.com (\u003cstrong\u003emi\u003c/strong\u003ea)","displayName":"Mia Krystof","avatarUrl":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16\u0026s=16"}],"total":25,"header":"Showing 20 of 25 matching groups"}