🔍 What is the Users API?
The Users API v1 provides read-only access to user profiles registered in your Clara organization. It allows external systems to retrieve user information such as names, emails, roles, and statuses.
This version is ideal for integrations that require:
- Listing users for mapping or sync purposes
- Displaying user names or emails in custom dashboards
- Linking other entities (transactions, cards, policies) with user metadata
🆚 Note: This is a read-only API. For user creation and updates, use Users API v2.
📌 Available Endpoints
| Operation | Endpoint | Method |
|---|---|---|
| List all users | /v1/users | GET |
| Get user by UUID | /v1/users/{uuid} | GET |
1️⃣ List all users
Use this endpoint to retrieve a list of all users in your organization. The response includes basic information for each user such as name, email, and status.
🔗 Endpoint
GET /v1/users
📤 cURL Request
curl -X GET \
"https://public-api.mx.clara.com/api/v1/users" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
📥 Sample JSON Response
[
{
"uuid": "user-123",
"fullName": "Ana Gómez",
"email": "[email protected]",
"status": "ACTIVE",
"role": "EMPLOYEE"
},
{
"uuid": "user-456",
"fullName": "Luis Torres",
"email": "[email protected]",
"status": "DISABLED",
"role": "ADMIN"
}
]
2️⃣ Find user by UUID
Use this endpoint to retrieve detailed information about a specific user using their unique identifier (uuid).
🔗 Endpoint
GET /v1/users/{uuid}
📤 cURL Request
curl -X GET \
"https://public-api.mx.clara.com/api/v1/users/user-123" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
📥 Sample JSON Response
{
"uuid": "user-123",
"fullName": "Ana Gómez",
"email": "[email protected]",
"status": "ACTIVE",
"role": "EMPLOYEE"
}
💡 Tip: Combine this API with other entity UUIDs (e.g., transactions or cards) to enrich reporting or audit logs with human-readable user information.
⚠️ Note: This API is read-only and does not support creation, update, or deactivation of users.