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

# List users

> List the app's users — distinct document owners with document counts.

Each ``user_id`` is a valid ``X-As-User`` value (the exact owner key
ingestion stamped). ``display_name`` is best-effort enrichment from the
Person roster. Requires an app-scoped API key or admin JWT; user JWTs are
rejected by the AppScoped gate — a user token is already bound to one
identity and doesn't get to enumerate the roster.



## OpenAPI

````yaml https://app.stainlessapi.com/api/spec/documented/hyperspell.yaml get /users
openapi: 3.1.0
info:
  title: Hyperspell API
  summary: >-
    Hyperspell is the memory layer for AI apps and agents. Through the API, you
    can add memories, connect data sources to index them in real-time, and
    search memories with our natural language query engine.
  termsOfService: https://hyperspell.com/blog/tos
  contact:
    name: Hyperspell
    url: https://hyperspell.com/
    email: hello@hyperspell.com
  version: 0.32.1
servers:
  - url: https://api.hyperspell.com
    description: Production
security:
  - APIKey: []
    AsUser: []
paths:
  /users:
    get:
      tags:
        - Users
        - Users
      summary: List users
      description: >-
        List the app's users — distinct document owners with document counts.


        Each ``user_id`` is a valid ``X-As-User`` value (the exact owner key

        ingestion stamped). ``display_name`` is best-effort enrichment from the

        Person roster. Requires an app-scoped API key or admin JWT; user JWTs
        are

        rejected by the AppScoped gate — a user token is already bound to one

        identity and doesn't get to enumerate the roster.
      operationId: list_users_users_get
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            default: 50
            title: Limit
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
            title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUsersResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKey: []
        - AsUser: []
components:
  schemas:
    ListUsersResponse:
      properties:
        users:
          items:
            $ref: '#/components/schemas/UserInfo'
          type: array
          title: Users
        total:
          type: integer
          title: Total
        limit:
          type: integer
          title: Limit
        offset:
          type: integer
          title: Offset
      type: object
      required:
        - users
        - total
        - limit
        - offset
      title: ListUsersResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UserInfo:
      properties:
        user_id:
          type: string
          title: User Id
        display_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Display Name
        document_count:
          type: integer
          title: Document Count
        last_indexed:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Indexed
      type: object
      required:
        - user_id
        - document_count
      title: UserInfo
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKey:
      type: http
      description: >-
        API Key or JWT User Token. If using an API Key, set the X-As-User header
        to act as a specific user. A JWT User Token is always scoped to a
        specific user.
      scheme: bearer
      bearerFormat: Bearer <token>
    AsUser:
      type: apiKey
      description: >-
        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
      in: header
      name: X-As-User

````