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 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.

Servers

https://your-domain.atlassian.net

Query parameters

Name	Type	Required	Description
`showAvatar`	Boolean	No	Include the URI to the user's avatar. Default value: false
`query`	String	Yes	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	No	The maximum number of items to return. The total number of matched users is returned in `total`. Default value: 50
`avatarSize`	String	No
`excludeConnectUsers`	Boolean	No	Default value: false
`excludeAccountIds[]`	Array	No	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`.
`exclude[]`	Array	No	This parameter is no longer available. See the deprecation notice for details.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.