Fetching data...
Developer API Reference
Build powerful integrations with our platform APIs.
Developer API Reference
Build powerful integrations with our platform APIs.
Users
Dynamic API reference synchronized with our latest backend endpoints.
GET
Get user details
/api/users/{id}Returns detailed profile and access information for a specific user.
Parameters
idRequiredstringThe user UUID
Example Request
bashcurl -X GET "https://your-tenant.peoplelensai.com/api/users/{id}" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" Example Response
json{
"user": {
"id": "usr-123e4567-e89b-12d3-a456-426614174000",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"company_role": "Software Engineer",
"is_enabled": true,
"user_preferences": [
{
"role": "User"
}
]
}
}PATCH
Update a user profile
/api/users/{id}Modifies the profile, permissions, or access status for a specific user.
Parameters
idRequiredstringThe user UUID
first_namestringlast_namestringrolestringis_enabledbooleanExample Request
bashcurl -X PATCH "https://your-tenant.peoplelensai.com/api/users/{id}" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{"first_name":"string","last_name":"string","role":"User","is_enabled":true}'Example Response
json{
"success": true
}DELETE
Remove user access
/api/users/{id}Revokes user access from the tenant and unassigns them from any relevant records.
Parameters
idRequiredstringThe user UUID
Example Request
bashcurl -X DELETE "https://your-tenant.peoplelensai.com/api/users/{id}" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" Example Response
json{
"success": true
}GET
List users
/api/usersReturns a list of users with access to the current tenant. Admins see full details, others see limited profiles.
Parameters
searchstringsearch by email or name
rolestringfilter by role
Example Request
bashcurl -X GET "https://your-tenant.peoplelensai.com/api/users" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" Example Response
json{
"users": [
{
"id": "usr-123e4567-e89b-12d3-a456-426614174000",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"company_role": "Software Engineer",
"is_enabled": true
}
]
}POST
Invite or create user
/api/usersProvisions a new user account and grants access to the tenant.
Parameters
emailRequiredstringpasswordRequiredstringfirst_nameRequiredstringlast_nameRequiredstringrolestringExample Request
bashcurl -X POST "https://your-tenant.peoplelensai.com/api/users" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{"email":"string","password":"string","first_name":"string","last_name":"string","role":"User"}'Example Response
json{
"success": true,
"user": {
"id": "usr-123e4567-e89b-12d3-a456-426614174000",
"email": "jane.smith@example.com"
}
}