> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search Users

Returns a list of users that match the search string and property.

This operation takes the users in the range defined by `startAt` and `maxResults`, up to the thousandth user, and then returns only the users from that range that match the search string and property. This means the operation usually returns fewer users than specified in `maxResults`. 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.

**Permissions required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls or calls by users without the required permission return empty search results.

<Note>
  External Documentation

  To learn more, visit the [Jira documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-group-user-search).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter | Description                                                                                                                                                                                                                                                                                                                                                                                                    |
  | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Query     | A query string that is matched against user attributes ( `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](mailto:johnson@example.com)*. Required, unless `accountId` or `property` is specified. |
  | Username  | The username to search for.                                                                                                                                                                                                                                                                                                                                                                                    |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter | Description                                                               |
  | --------- | ------------------------------------------------------------------------- |
  | Limit     | The maximum number of items to return per page.                           |
  | Offset    | The index of the first item to return in a page of results (page offset). |
</div>

## Example Output

```json theme={"dark"}
[
	{
		"accountId": "5b10a2844c20165700ede21g",
		"accountType": "atlassian",
		"active": false,
		"avatarUrls": {
			"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16\u0026s=16",
			"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24\u0026s=24",
			"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32\u0026s=32",
			"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48\u0026s=48"
		},
		"displayName": "Mia Krystof",
		"key": "",
		"name": "",
		"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
	},
	{
		"accountId": "5b10ac8d82e05b22cc7d4ef5",
		"accountType": "atlassian",
		"active": false,
		"avatarUrls": {
			"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16\u0026s=16",
			"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24\u0026s=24",
			"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32\u0026s=32",
			"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48\u0026s=48"
		},
		"displayName": "Emma Richards",
		"key": "",
		"name": "",
		"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5"
	}
]
```

## Workflow Library Example

[Search Users with Jira and Send Results Via Email](https://library.blinkops.com/workflows/search-users-with-jira-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/search-users-with-jira-and-send-results-via-email/canvas" />
</div>