Sign in
People

Get all people

Returns all members for the authenticated organization with their user information. Supports both API key authentication (X-API-Key header) and session authentication (Bearer token or cookies).

get/v1/people

Query parameters

includeDeactivatedstring required

Response

People retrieved successfully

countnumber

Total number of people

authType'api-key' | 'session'

How the request was authenticated

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"
  }
}

Changes