# Query Employee Timecards

Endpoint: GET /companies/{companyId}/timecards/employees
Version: 1.0

## Path parameters:

  - `companyId` (string, required)

## Query parameters:

  - `id` (array, required)

  - `employeeId` (array, required)

  - `workplaceId` (array, required)

  - `status` (array, required)
    Enum: "InProgress", "Pending", "Approved", "Denied"

  - `search` (string)

  - `includeId` (boolean)

  - `includeEmployeeId` (boolean)

  - `includeWorkplaceId` (boolean)

  - `includeStatus` (boolean)

  - `includeSearch` (boolean)

  - `page` (integer)

  - `pageSize` (integer)

## Response 200 fields (application/json):

  - `hasResources` (boolean)

  - `totalResources` (integer)

  - `totalPages` (integer)

  - `pageSize` (integer)

  - `currentPage` (integer,null)

  - `previousPage` (integer,null)

  - `nextPage` (integer,null)

  - `results` (array,null)

  - `results.id` (string)

  - `results.employeeId` (string)

  - `results.workplaceId` (string)

  - `results.status` (string)
    Enum: "InProgress", "Pending", "Approved", "Denied"

  - `results.clockInNote` (string,null)

  - `results.clockOutNote` (string,null)

  - `results.clockIn` (string,null)

  - `results.clockOut` (string,null)

  - `results.breaks` (array,null)

  - `results.breaks.acceptedStatus` (boolean)

  - `results.breaks.type` (string)
    Enum: "PaidMealBreak", "UnpaidMealBreak", "PaidRestBreak", "UnpaidRestBreak"

  - `results.breaks.breakStartNote` (string,null)

  - `results.breaks.breakEndNote` (string,null)

  - `results.breaks.breakStart` (string,null)

  - `results.breaks.breakEnd` (string,null)

  - `results.breaks.changes` (array,null)

  - `results.breaks.changes.originalAcceptedStatus` (boolean)

  - `results.breaks.changes.newAcceptedStatus` (boolean)

  - `results.breaks.changes.originalType` (string)
    Enum: "PaidMealBreak", "UnpaidMealBreak", "PaidRestBreak", "UnpaidRestBreak"

  - `results.breaks.changes.newType` (string)
    Enum: "PaidMealBreak", "UnpaidMealBreak", "PaidRestBreak", "UnpaidRestBreak"

  - `results.breaks.changes.originalBreakStart` (string,null)

  - `results.breaks.changes.newBreakStart` (string,null)

  - `results.breaks.changes.originalBreakEnd` (string,null)

  - `results.breaks.changes.newBreakEnd` (string,null)

  - `results.breaks.changes.modifiedById` (string,null)

  - `results.breaks.changes.modifiedByName` (string,null)

  - `results.breaks.changes.modifiedByEmail` (string,null)

  - `results.breaks.changes.modifiedByPhone` (string,null)

  - `results.breaks.changes.modifiedReason` (string,null)

  - `results.breaks.changes.modifiedAt` (string)