Sign in
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

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

Changed in 5 of the 51 revisions of this API.614

  • 5a440666fc044See the full diff
    • ▲

      added the new required query request parameter offboardAfter

      new-required-request-parameter

    • ▲

      added the new required query request parameter offboardBefore

      new-required-request-parameter

    • ▲

      added the new required query request parameter onboardAfter

      new-required-request-parameter

    • ▲

      added the new required query request parameter onboardBefore

      new-required-request-parameter

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 36253e8a5c1b1See the full diff
    • ○

      added the optional property data/items/backgroundCheckRequests to the response with the 200 status

      response-optional-property-added

  • 805d5411bc331See the full diff
    • ○

      added the required property data/items/deactivated to the response with the 200 status

      response-required-property-added

  • 9b8ae4b8ab6711See the full diff
    • ▲

      removed the required property data/items/user/allOf[UserResponseDto]/isPlatformAdmin from the response with the 200 status

      response-required-property-removed

    • ○

      added the required property data/items/user/allOf[UserResponseDto]/role to the response with the 200 status

      response-required-property-added

  • 946edaa856a9111See the full diff
    • ▲

      added the new required query request parameter includeDeactivated

      new-required-request-parameter

    • ●

      deleted the header request parameter X-Organization-Id

      request-parameter-removed

    • ○

      added the required property data/items/user/allOf[UserResponseDto]/isPlatformAdmin to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog