Skip to main content
GET
/
v1
/
organizations
/
users
List Users
curl --request GET \
  --url https://api.mixpeek.com/v1/organizations/users
{}

Documentation Index

Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string

Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Example:

"Bearer YOUR_MIXPEEK_API_KEY"

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 temporarily disabled. API keys will not work but account data is preserved. Can be reactivated by an admin.
  • 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.