TRtrycompai
People

List workforce members

Changed on

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

get/v1/people

Request

  • Base URL
    https://api.trycomp.ai
  • Auth
    API key in header X-API-Key

Query parameters

includeDeactivatedstring required
onboardAfterstring required
onboardBeforestring required
offboardAfterstring required
offboardBeforestring 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

  • 33c685841b7aRevision changes
    • info

      removed the admin enum value from the // response property for the response status

    • info

      removed the gov enum value from the // response property for the response status

    • info

      removed the hr enum value from the // response property for the response status

    • info

      removed the it enum value from the // response property for the response status

    • info

      removed the itsm enum value from the // response property for the response status

    • info

      removed the none enum value from the // response property for the response status

    • info

      removed the qms enum value from the // response property for the response status

  • 7ca7c363a732Revision changes
    • warning

      added the new admin enum value to the // response property for the response status

    • warning

      added the new gov enum value to the // response property for the response status

    • warning

      added the new hr enum value to the // response property for the response status

    • warning

      added the new it enum value to the // response property for the response status

    • warning

      added the new itsm enum value to the // response property for the response status

    • warning

      added the new none enum value to the // response property for the response status

    • warning

      added the new qms enum value to the // response property for the response status