Fetching data...
Developer API Reference
Build powerful integrations with our platform APIs.
Developer API Reference
Build powerful integrations with our platform APIs.
Public-api-security-scim-
Dynamic API reference synchronized with our latest backend endpoints.
GET
Retrieve Audit Logs
/api/v1/audit-logsFetch system activity and audit logs for the tenant, primarily intended for SIEM integration.
Parameters
actionstringFilter by specific action (e.g., USER_LOGIN, CANDIDATE_DELETED)
sincestringFetch logs created after this timestamp
limitintegerMaximum number of logs to return (max 100)
offsetintegerPagination offset
Example Request
bashcurl -X GET "https://your-tenant.peoplelensai.com/api/v1/audit-logs" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" Example Response
json{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"action": "string",
"entity_type": "string",
"entity_id": "string",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"details": {},
"created_at": "2026-03-01T10:35:39.817Z"
}
],
"pagination": {
"total": 0,
"limit": 0,
"offset": 0
}
}GET
Get User (SCIM Sync)
/api/v1/users/{id}Retrieve a specific user by ID.
Parameters
idRequiredstringExample Request
bashcurl -X GET "https://your-tenant.peoplelensai.com/api/v1/users/{id}" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" DELETE
Deactivate User (SCIM Sync)
/api/v1/users/{id}Soft delete/deactivate a user from the tenant.
Parameters
idRequiredstringExample Request
bashcurl -X DELETE "https://your-tenant.peoplelensai.com/api/v1/users/{id}" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" GET
List Users (SCIM Sync)
/api/v1/usersRetrieve a list of active users in the tenant.
Parameters
emailstringFilter by exact email
limitintegerExample Request
bashcurl -X GET "https://your-tenant.peoplelensai.com/api/v1/users" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" Example Response
json{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"email": "string",
"first_name": "string",
"last_name": "string",
"role": "string"
}
]
}POST
Provision User (SCIM Sync)
/api/v1/usersCreate or provision a new user in the tenant with a specific role via email invitation.
Parameters
emailRequiredstringfirst_nameRequiredstringlast_nameRequiredstringrolestringRole: Recruiter, HiringManager, Interviewer, Administrator
Example Request
bashcurl -X POST "https://your-tenant.peoplelensai.com/api/v1/users" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{"email":"user@example.com","first_name":"string","last_name":"string","role":"string"}'