Skip to main content
GET
/
timesheets
/
{timesheet_id}
Get a timesheet
curl --request GET \
  --url https://{base_url}/api/v1/timesheets/{timesheet_id} \
  --header 'Authorization: Bearer <token>'
{
  "__type": "SSJSON_API_Timesheet",
  "id": "2240_11417925",
  "approvedHours": null,
  "approvedPayroll": null,
  "casualJob": false,
  "clockIn": null,
  "clockOut": null,
  "contractedHoursId": "2924_294328",
  "date": "2026-04-21",
  "department": {
    "id": "2784_119",
    "name": "Deli"
  },
  "details": [
    {
      "id": "2759_52442232",
      "activity": "2760_183",
      "alternateDepartment": "",
      "alternateOrganisation": "",
      "finishTime": "2026-04-21T07:00:00.000Z",
      "hours": 6,
      "mealBreak": false,
      "restBreak": false,
      "startTime": "2026-04-21T01:00:00.000Z"
    }
  ],
  "employeeId": "2095_1144974",
  "finishTime": "2026-04-21T07:00:00.000Z",
  "hoursToPay": 6,
  "includesLeave": false,
  "organisationPayRollId": "2089_9531",
  "organisationWorkedId": "2089_9531",
  "overnight": false,
  "processed": null,
  "role": {
    "id": "2213_6559",
    "name": "Retail Assistant"
  },
  "shift": null,
  "startTime": "2026-04-21T01:00:00.000Z"
}

Authorizations

Authorization
string
header
required

Access token obtained from /oauth/token. Pass as Authorization: Bearer {token}

Path Parameters

timesheet_id
string
required

The unique identifier of the timesheet to retrieve

Example:

"2240_11417925"

Response

Timesheet details

__type
string

Internal type identifier

Example:

"SSJSON_API_Timesheet"

id
string

The unique identifier for the timesheet

Example:

"2240_11417925"

approvedHours
number | null

The number of approved hours. Null if not yet approved.

Example:

null

approvedPayroll
string | null

The approved payroll reference. Null if not yet approved.

Example:

null

casualJob
boolean

Whether this timesheet is for a casual job

Example:

false

clockIn
string<date-time> | null

The clock-in time in ISO 8601 format. Null if not clocked in.

Example:

null

clockOut
string<date-time> | null

The clock-out time in ISO 8601 format. Null if not clocked out.

Example:

null

contractedHoursId
string

The ID of the contracted hours entry this timesheet was generated from

Example:

"2924_294328"

date
string<date>

The date of the timesheet in YYYY-MM-DD format

Example:

"2026-04-21"

department
object

A minimal department reference used within contracted hours

details
object[]

A list of detail entries breaking down the timesheet into activity segments

employeeId
string

The ID of the employee this timesheet belongs to

Example:

"2095_1144974"

finishTime
string<date-time>

The overall finish time of the timesheet in ISO 8601 format

Example:

"2026-04-21T07:00:00.000Z"

hoursToPay
number

The total payable hours for this timesheet

Example:

6

includesLeave
boolean

Whether this timesheet includes any leave

Example:

false

organisationPayRollId
string

The ID of the organisation responsible for payroll

Example:

"2089_9531"

organisationWorkedId
string

The ID of the organisation where the work was performed

Example:

"2089_9531"

overnight
boolean

Whether this timesheet spans overnight

Example:

false

processed
string | null

The date/time the timesheet was processed for payroll. Null if not yet processed.

Example:

null

role
object

A minimal role reference used within contracted hours

shift
object

The shift template applied to this timesheet. Null if not shift-based.

startTime
string<date-time>

The overall start time of the timesheet in ISO 8601 format

Example:

"2026-04-21T01:00:00.000Z"