---
title: "List users"
method: GET
path: "/users"
tags: ["Users"]
---

# List users

`GET /users`

## Request

- Base URL: `https://api.hyperspell.com`
- URL: `https://api.hyperspell.com/users`
- Auth: HTTP bearer

List the app's users — the users who added documents, with document counts.

Each ``user_id`` is valid for the ``X-As-User`` header. ``display_name`` is
included when available. Requires an app-scoped credential; user-scoped
credentials cannot enumerate other users.

## Query parameters

- `limit` integer
- `offset` integer

## Headers

- `X-As-User` string, nullable: Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

## Response `200`

Successful Response

- ListUsersResponse
  - `users` UserInfo[], required
    - `user_id` string, required
    - `display_name` string, nullable
    - `document_count` integer, required
    - `last_indexed` string, date-time, nullable
  - `total` integer, required
  - `limit` integer, required
  - `offset` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/hyperspell/apis/hyperspell-api.md) - [All operations](https://skmtc.dev/hyperspell/apis/hyperspell-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hyperspell/apis/hyperspell-api/revisions/9bafd1215a0f?raw)