---
title: "GET /users/search - Users · RUAL Documentation"
description: "Search users (query) with Elasticsearch query parameters"
canonical: https://docs.rual.nl/cluster/api/users/users-search-get
language: en
---

# GET /users/search

Search users (query) with Elasticsearch query parameters

| Key | Type | Example | Description |
| --- | --- | --- | --- |
| **offset** optional | `integer` | `1` | Elasticsearch query offset parameter |
| **limit** optional | `integer` | `1` | Elasticsearch query limit parameter |

| Key | Type | Example | Description |
| --- | --- | --- | --- |
| **[authorization](https://docs.rual.nl/cluster/api#token-providing)** required | `string` | `"Bearer access_token"` | Access token |

```
{}
```

```
{
  "error": "ERROR_KEY"
}
```

| Permission | Description |
| --- | --- |
| `Bearer token` | Access token required via Authorization header, x-authtoken, x-token, query param, or cookie |
| `users_search` | Required scope: users_search |
| `setting_manage_users` | Additional permission check: setting_manage_users |
