List workforce members | Comp AI API

List employees and contractors with onboarding, training, device, and compliance status used for people-security controls.

GET /v1/people

List workforce members

cURL

curl --request GET \
  --url https://api.trycomp.ai/v1/people \
  --header 'X-API-Key: <api-key>'

200

{
  "data": [
    {
      "id": "mem_abc123def456",
      "organizationId": "org_abc123def456",
      "userId": "usr_abc123def456",
      "role": "admin",
      "createdAt": "2024-01-01T00:00:00Z",
      "department": "it",
      "isActive": true,
      "fleetDmLabelId": 123,
      "user": {
        "id": "usr_abc123def456",
        "name": "John Doe",
        "email": "[e-mail]",
        "emailVerified": true,
        "image": "https://example.com/avatar.jpg",
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-15T00:00:00Z",
        "lastLogin": "2024-01-15T12:00:00Z"
      }
    }
  ],
  "count": 1,
  "authType": "api-key",
  "authenticatedUser": {
    "id": "usr_abc123def456",
    "email": "[e-mail]"
  }
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Query Parameters

includeDeactivated · string · required

Response

200

application/json

People retrieved successfully

data · object[]

Show child attributes

count · number

Total number of people

Example:

25

authType · enum<string>

How the request was authenticated

Available options: api-key, session

authenticatedUser · object

Show child attributes