GET /api/time_and_attendance_batches
Get time & attendance batches

List time & attendance batches for the current company.

Access: managers and accountants.

Examples

{
  "collection": [
    {
      "id": 42,
      "company_id": 7,
      "work_time_group_id": 3,
      "period_start": "2026-04-01",
      "period_end": "2026-04-30",
      "state": "reviewing",
      "created_at": "2026-05-01T08:30:00.000Z",
      "updated_at": "2026-05-01T08:30:05.000Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1
  }
}

Params

Param name Description
page
optional

Page number.

Validations:

  • Must be a Integer
per_page
optional

Number of records per page. Default: 50.

Validations:

  • Must be a Integer
work_time_group_id
optional

Filter by work time group ID.

Validations:

  • Must be a Integer
state
optional

Filter by state.

Validations:

  • Must be one of: draft, reviewing, reporting, reported.
start_date
optional

Filter by exact period start date, e.g. 2025-01-01 or 01/01/2025.

Validations:

  • Must be a String
end_date
optional

Filter by exact period end date, e.g. 2025-01-31 or 31/01/2025.

Validations:

  • Must be a String
date_range
optional

Filter by overlap with a date range. Format: "DD/MM/YYYY - DD/MM/YYYY" (e.g. 01/01/2025 - 31/01/2025).

Validations:

  • Must be a String
sort_by
optional

Sort by field. Default: period_start.

Validations:

  • Must be a String
order
optional

Sorting order. Default: desc.

Validations:

  • Must be one of: desc, asc.