v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Timesheets

List timesheets

Lists all timesheets.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage timeoffs (time_and_attendance)	View timesheets (timesheet:read)	Manage timesheets (timesheet:write)

get/v1/timesheets

Query parameters

status'open' | 'submitted' | 'approved' | 'in_calibration' | 'processed'

The current status of a timesheet in its lifecycle.

open: The timesheet is a draft and only visible to the employee. It has not been submitted yet.
submitted: The employee has submitted the timesheet for review. It is awaiting approval.
approved: The timesheet has been approved and will be included in the next payroll run.
in_calibration: The timesheet was sent back to the employee for revision. The employee needs to correct and resubmit it.
processed: The timesheet has been processed as part of a payroll run. This is a terminal state.

Example:submitted

Filter timesheets by their status

order'asc' | 'desc'

Sort order

sort_by'submitted_at'

Field to sort by

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "current_page": 1,
  "timesheets": [
    {
      "approval_required": true,
      "break_hours": {
        "hours": 35,
        "minutes": 13
      },
      "country_code": "PRT",
      "employment_id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
      "end_date": "2021-07-01",
      "holiday_hours": {
        "hours": 35,
        "minutes": 13
      },
      "id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
      "night_hours": {
        "hours": 35,
        "minutes": 13
      },
      "notes": "Some notes",
      "on_call_hours": {
        "hours": 35,
        "minutes": 13
      },
      "overtime_hours": {
        "hours": 35,
        "minutes": 13
      },
      "regular_hours": {
        "hours": 35,
        "minutes": 13
      },
      "start_date": "2021-07-01",
      "status": "submitted",
      "submitted_at": "2021-07-15T18:18:17Z",
      "time_trackings": [
        {
          "clock_in": "2021-07-15T18:18:17Z",
          "clock_out": "2021-07-15T18:18:17Z",
          "has_holiday_hours": false,
          "has_night_hours": false,
          "has_weekend_hours": false,
          "holiday_hours": {
            "hours": 35,
            "minutes": 13
          },
          "night_hours": {
            "hours": 35,
            "minutes": 13
          },
          "notes": "Time tracking project.",
          "time_breakdown": {
            "day": {
              "holiday": {
                "hours": 35,
                "minutes": 13
              },
              "regular": {
                "hours": 35,
                "minutes": 13
              },
              "weekend": {
                "hours": 35,
                "minutes": 13
              }
            },
            "night": {
              "holiday": {
                "hours": 35,
                "minutes": 13
              },
              "regular": {
                "hours": 35,
                "minutes": 13
              },
              "weekend": {
                "hours": 35,
                "minutes": 13
              }
            }
          },
          "timezone": "Etc/UTC",
          "total_hours": {
            "hours": 35,
            "minutes": 13
          },
          "type": "regular_hours",
          "weekend_hours": {
            "hours": 35,
            "minutes": 13
          }
        }
      ],
      "total_hours": {
        "hours": 35,
        "minutes": 13
      },
      "unpaid_break_hours": {
        "hours": 35,
        "minutes": 13
      },
      "weekend_hours": {
        "hours": 35,
        "minutes": 13
      }
    }
  ],
  "total_count": 1,
  "total_pages": 1
}