Page number to return.
Beta Admin Users Endpoints
(beta) Admin API - manage users. Requires an admin API key.
Examples
Real world code examples
Get Users
GET /v1/admin/users#
List Organization members and pending invitations.
AdminApiKey#
200
OK
Total number of users and invitations that match the request.
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/admin/users \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/admin/users \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
{
"invites": [
{
"created_at": "2025-12-17T10:25:07.818693Z",
"email": "alice.martin@example.com",
"expired": false,
"raw_role": "A",
"raw_roles": [
"A"
],
"uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}
],
"members": [
{
"created_at": "2025-12-17T10:25:07.818693Z",
"email": null,
"name": null,
"oid_id": null,
"raw_role": "A",
"raw_roles": [
"A"
],
"uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}
],
"page": null,
"page_size": null,
"total": null
}{
"invites": [
{
"created_at": "2025-12-17T10:25:07.818693Z",
"email": "alice.martin@example.com",
"expired": false,
"raw_role": "A",
"raw_roles": [
"A"
],
"uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}
],
"members": [
{
"created_at": "2025-12-17T10:25:07.818693Z",
"email": null,
"name": null,
"oid_id": null,
"raw_role": "A",
"raw_roles": [
"A"
],
"uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}
],
"page": null,
"page_size": null,
"total": null
}Create Users
POST /v1/admin/users#
Create Organization members.
AdminApiKey#
OrganizationMemberCreate#
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/admin/users \
-X POST \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '[
{
"email": "alice.martin@example.com",
"first_name": "Alice",
"last_name": "Martin"
}
]'curl https://api.mistral.ai/v1/admin/users \
-X POST \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '[
{
"email": "alice.martin@example.com",
"first_name": "Alice",
"last_name": "Martin"
}
]'200
{
"email_to_user_id": [
"ipsum eiusmod"
],
"invalid_emails": [
"consequat do"
]
}{
"email_to_user_id": [
"ipsum eiusmod"
],
"invalid_emails": [
"consequat do"
]
}Playground
Test the endpoints live
curl https://api.mistral.ai/v1/admin/users-invite \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/admin/users-invite \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
[
{
"email": null,
"invite_uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"role": "A",
"roles": [
"A"
]
}
][
{
"email": null,
"invite_uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"role": "A",
"roles": [
"A"
]
}
]Invite Users
POST /v1/admin/users-invite#
Invite users to the Organization.
AdminApiKey#
email_language#
Language used for invitation emails.
role#
Deprecated legacy single role value, kept for backward compatibility. Mutually exclusive with 'role_name'.
role_name#
Deprecated single role name, kept for backward compatibility. Mutually exclusive with 'role'.
role_names#
Simplified role names to assign. Mutually exclusive with 'roles'.
roles#
Role values to assign. Mutually exclusive with 'role_names'.
subscription_seat_automatic_granting#
Default Value: false
Whether to grant subscription seats automatically.
subscription_type#
Deprecated single product seat to assign.
subscription_types#
Product seats to assign to the user.
workspace_uuids#
Workspace IDs the invited users should join.
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/admin/users-invite \
-X POST \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"email": "alice.martin@example.com, bob.smith@example.com"
}'curl https://api.mistral.ai/v1/admin/users-invite \
-X POST \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"email": "alice.martin@example.com, bob.smith@example.com"
}'200
{
"already_members": [
"ipsum eiusmod"
],
"invalid_emails": [
"consequat do"
]
}{
"already_members": [
"ipsum eiusmod"
],
"invalid_emails": [
"consequat do"
]
}Delete Invite
DELETE /v1/admin/users-invite/{invite_uuid}#
Delete Invite
AdminApiKey#
Organization invitation ID.
200
OK
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/admin/users-invite/{invite_uuid} \
-X DELETE \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'curl https://api.mistral.ai/v1/admin/users-invite/{invite_uuid} \
-X DELETE \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'200
{
"message": "Organization member deleted successfully"
}{
"message": "Organization member deleted successfully"
}Get User
GET /v1/admin/users/{user_id}#
Get details for an Organization member.
AdminApiKey#
User ID.
200
OK
is_sso_outsider#
Whether the member is outside the SSO domain.
Identity provider ID for the member.
raw_role#
Deprecated single organization role. Use 'raw_roles' instead.
raw_roles#
Organization roles assigned to the member.
subscription_types#
Product seats assigned to the member.
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/admin/users/{user_id} \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/admin/users/{user_id} \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
{
"created_at": "2025-12-17T10:25:07.818693Z",
"email": null,
"first_name": null,
"last_name": null,
"name": null,
"oid_id": null,
"raw_role": "A",
"raw_roles": [
"A"
],
"uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}{
"created_at": "2025-12-17T10:25:07.818693Z",
"email": null,
"first_name": null,
"last_name": null,
"name": null,
"oid_id": null,
"raw_role": "A",
"raw_roles": [
"A"
],
"uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}Delete User
DELETE /v1/admin/users/{user_id}#
Remove a member from the Organization.
AdminApiKey#
User ID.
200
OK
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/admin/users/{user_id} \
-X DELETE \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'curl https://api.mistral.ai/v1/admin/users/{user_id} \
-X DELETE \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'200
{
"message": "Organization member deleted successfully"
}{
"message": "Organization member deleted successfully"
}Update User
PATCH /v1/admin/users/{user_id}#
Update an Organization member's roles and product seats.
AdminApiKey#
User ID.
role#
Deprecated legacy single role value, kept for backward compatibility. Mutually exclusive with 'role_name'.
role_name#
Deprecated single role name, kept for backward compatibility. Mutually exclusive with 'role'.
role_names#
Simplified role names to assign. Mutually exclusive with 'roles'.
roles#
Role values to assign. Mutually exclusive with 'role_names'.
subscription_types#
Product seats to assign to the member.
200
OK
is_sso_outsider#
Whether the member is outside the SSO domain.
Identity provider ID for the member.
raw_role#
Deprecated single organization role. Use 'raw_roles' instead.
raw_roles#
Organization roles assigned to the member.
subscription_types#
Product seats assigned to the member.
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/admin/users/{user_id} \
-X PATCH \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{}'curl https://api.mistral.ai/v1/admin/users/{user_id} \
-X PATCH \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{}'200
{
"created_at": "2025-12-17T10:25:07.818693Z",
"email": null,
"name": null,
"oid_id": null,
"raw_role": "A",
"raw_roles": [
"A"
],
"uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}{
"created_at": "2025-12-17T10:25:07.818693Z",
"email": null,
"name": null,
"oid_id": null,
"raw_role": "A",
"raw_roles": [
"A"
],
"uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}Playground
Test the endpoints live
curl https://api.mistral.ai/v1/admin/roles \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/admin/roles \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
{
"organization_roles": [
{
"description": "Can manage workspace members and settings",
"is_custom_role": false,
"name": "workspace_admin",
"uuid": null
}
],
"workspace_roles": [
{
"description": "Can manage workspace members and settings",
"is_custom_role": false,
"name": "workspace_admin",
"uuid": null
}
]
}{
"organization_roles": [
{
"description": "Can manage workspace members and settings",
"is_custom_role": false,
"name": "workspace_admin",
"uuid": null
}
],
"workspace_roles": [
{
"description": "Can manage workspace members and settings",
"is_custom_role": false,
"name": "workspace_admin",
"uuid": null
}
]
}