GET /rest/api/2/user/search
Returns a list of active users that match the search string and property.
This operation first applies a filter to match the search string and property, and then takes the filtered users in the range defined by startAt and maxResults, up to the thousandth user. To get all the users who match the search string and property, use Get all users and filter the records in your code.
This operation can be accessed anonymously.
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.
Permissions required: Browse users and groups global permission. Anonymous calls or calls by users without the required permission return empty search results.
Servers
- https://your-domain.atlassian.net
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
startAt |
Integer | No |
The index of the first item to return in a page of filtered results (page offset). Default value: 0 |
query |
String | No |
A query string that is matched against user attributes ( |
username |
String | No | |
maxResults |
Integer | No |
The maximum number of items to return per page. Default value: 50 |
accountId |
String | No |
A query string that is matched exactly against a user |
property |
String | No |
A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of |
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.