Skip to main content
GET
List Users

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

Query Parameters

skip
integer
default:0
Required range: x >= 0
limit
integer
default:50
Required range: 1 <= x <= 1000
role
enum<string> | null

High-level organization role applied to users.

Roles define the baseline permissions a user has within an organization:

  • ADMIN: Full administrative access including user management, billing, and organization settings. Can create/modify/delete all resources.
  • MEMBER: Standard user access. Can create and manage their own resources (namespaces, collections, clusters) but cannot manage other users or organization-level settings.
  • VIEWER: Read-only access. Can view resources and execute retrievers but cannot create, modify, or delete any resources.
Available options:
admin,
member,
viewer
status
enum<string> | null

Lifecycle state of an organization user.

Status values control whether a user can authenticate and access resources:

  • ACTIVE: User is fully operational and can authenticate with their API keys.
  • SUSPENDED: User access is disabled. Setting this status revokes every API key the user owns, and no new key can be created for them while suspended. Account data is preserved. An admin can reactivate the user, who then creates new keys: the revoked keys stay revoked.
  • PENDING: User invitation has been created but not yet accepted. User cannot authenticate until they complete the onboarding flow.
Available options:
active,
suspended,
pending

Response

Successful Response

The response is of type Response List Users V1 Organizations Users Get · object.