Sign in

e9f0790a89af

latestOpenAPI 3.0.12026-07-26222700728.0 KB
Employee Management

Query employees

Query employees for the authenticated user

post/v6/employees/query

Request body

cursorstring nullable

Cursor from the previous paginated response

limitinteger

Page size, i.e. number of items to return per page

Response

Success

result'SUCCESS' | 'FAILURE'

The result of the action performed.

Example response

{
  "data": [
    {
      "id": "emp_12345",
      "userId": "usr_67890",
      "email": "employee@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "billableRate": 150,
      "ownershipPercentage": 25.5,
      "dimensionValues": [
        {
          "id": "dv_593051",
          "dimension": {
            "id": "dim_4521",
            "name": "Region",
            "requiredness": "NOT_REQUIRED"
          },
          "name": "Mid-Atlantic",
          "child": {
            "id": "dv_593052",
            "dimension": {
              "id": "dim_4521",
              "name": "Region",
              "requiredness": "NOT_REQUIRED"
            },
            "name": "Washington DC"
          }
        }
      ],
      "status": "ACTIVE",
      "customData": {
        "internal_key": "some_internal_key",
        "some_other_field": 23434
      }
    }
  ]
}