Authorizations
Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings.
Headers
REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.
"Bearer sk_live_abc123def456"
"Bearer sk_test_xyz789"
Query Parameters
x >= 01 <= x <= 1000High-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.
admin, member, viewer 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.
active, suspended, pending Response
Successful Response
The response is of type object.

