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

# List users

> Return Clumio users visible in the selected organizational-unit context.

Returns a paginated list of Clumio users.

## Headers

<ParamField header="Accept" type="string" default="application/api.clumio.users=v2+json">
  Selects version 2 of the users resource.
</ParamField>

<ParamField header="X-Clumio-OrganizationalUnit-Context" type="string">
  UUID of the organizational unit in which to perform the request.
</ParamField>

## Query parameters

<ParamField query="limit" type="number">
  Maximum number of users returned on each page.
</ParamField>

<ParamField query="start" type="string" default="1">
  Page number. Pages are indexed from `1`.
</ParamField>

<ParamField query="filter" type="string">
  JSON filter. Supported fields include `name`, `role_id`, and `organizational_unit_id`.
</ParamField>

## Response

<ResponseField name="_embedded.items" type="object[]">
  Users returned on the current page.
</ResponseField>

<ResponseField name="_links" type="object">
  HAL links for the current, first, last, next, and previous pages.
</ResponseField>

<ResponseField name="current_count" type="number">
  Number of users on the current page.
</ResponseField>

<ResponseField name="total_count" type="number">
  Total users across all pages.
</ResponseField>

```json theme={null}
{
  "_embedded": {
    "items": [
      {
        "id": "36",
        "email": "clumian@example.com",
        "full_name": "Clumian",
        "is_confirmed": true,
        "is_enabled": true
      }
    ]
  },
  "current_count": 1,
  "start": "1",
  "total_count": 1,
  "total_pages_count": 1
}
```

Errors return an `errors` array containing `error_code` and `error_message`.

## Next

* [Discover API resources](/api-reference/discovery)
* [List tasks](/api-reference/tasks/list-tasks)
