Find users for picker
GET
/rest/api/3/user/picker
User search
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.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.Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/user/picker?query='
Response 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
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
total
.showAvatar
stringÂ
optional
exclude
array[string]
optional
excludeAccountIds
array[string]
optional
excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5
. Cannot be provided with exclude
.avatarSize
stringÂ
optional
excludeConnectUsers
stringÂ
optional