Users
Users

List users

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.

get/users

Request

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

Query parameters

limitinteger
offsetinteger

Headers

X-As-Userstring 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

Successful Response

totalinteger required
limitinteger required
offsetinteger required

Changes

No operation changes recorded.