People
List workforce members
List employees and contractors with onboarding, training, device, and compliance status used for people-security controls.
get/v1/people
Query parameters
includeDeactivatedstring required
onboardAfterstring required
onboardBeforestring required
offboardAfterstring required
offboardBeforestring required
Response
People retrieved successfully
Example response
{
"data": [
{
"id": "mem_abc123def456",
"organizationId": "org_abc123def456",
"userId": "usr_abc123def456",
"role": "admin",
"createdAt": "2024-01-01T00:00:00Z",
"department": "it",
"isActive": true,
"user": {
"id": "usr_abc123def456",
"name": "John Doe",
"email": "john.doe@company.com",
"emailVerified": true,
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-15T00:00:00Z"
},
"backgroundCheckRequests": [
{
"id": "bcr_abc123def456",
"status": "invited"
}
]
}
],
"count": 25,
"authenticatedUser": {
"id": "usr_abc123def456",
"email": "user@company.com"
}
}