Get Timesheets

curl --request GET \
  --url https://app.untetherlabs.com/api/v1/timekeeping/timesheet \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "startDate": "2024-11-20T07:43:34+0000",
      "endDate": "2024-11-20T07:43:34+0000",
      "payPeriodId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "scheduledShifts": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdAt": "2024-11-20T07:43:34+0000",
          "startDate": "2024-11-20T07:43:34+0000",
          "endDate": "2024-11-20T07:43:34+0000",
          "segments": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "createdAt": "2024-11-20T07:43:34+0000",
              "role": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "isBreak": false,
              "isOnCall": false,
              "type": "working",
              "startDate": "2024-11-20T07:43:34+0000",
              "endDate": "2024-11-20T07:43:34+0000",
              "labels": [
                "<string>"
              ],
              "importedId": "<string>",
              "roleImportedId": "<string>",
              "additionalInfo": "<unknown>",
              "skillRequirement": {
                "type": "equal",
                "skill": "<string>",
                "value": "<string>"
              }
            }
          ],
          "workRuleOverride": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "provider": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "team": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "note": "<string>",
          "isExternal": true
        }
      ],
      "punches": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "timecardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdAt": "2024-11-20T07:43:34+0000",
          "updatedAt": "2024-11-20T07:43:34+0000",
          "action": "clock_in",
          "state": "pending",
          "time": "2024-11-20T07:43:34+0000",
          "providerNote": "Felt sick, had to leave early.",
          "adminNote": "Adjusted to schedule.",
          "generated": false
        }
      ],
      "provider": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Bruce Wayne",
        "email": "[email protected]",
        "hireDate": "2024-11-20T07:43:34+0000",
        "status": "active",
        "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "licensedRegions": [
          "<string>"
        ],
        "employmentType": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "paySegments": [
        {
          "id": "<string>",
          "type": "paid",
          "startDate": "2024-11-20T07:43:34+0000",
          "endDate": "2024-11-20T07:43:34+0000",
          "payCodes": [
            "<string>"
          ],
          "overtime": [
            "<string>"
          ],
          "timeRanges": [
            "<string>"
          ],
          "itemId": "<string>",
          "shiftId": "<string>",
          "timecardId": "<string>",
          "workRuleOverride": "<string>",
          "role": "<string>"
        }
      ],
      "scheduledPaySegments": [
        {
          "id": "<string>",
          "type": "paid",
          "startDate": "2024-11-20T07:43:34+0000",
          "endDate": "2024-11-20T07:43:34+0000",
          "payCodes": [
            "<string>"
          ],
          "overtime": [
            "<string>"
          ],
          "timeRanges": [
            "<string>"
          ],
          "itemId": "<string>",
          "shiftId": "<string>",
          "timecardId": "<string>",
          "workRuleOverride": "<string>",
          "role": "<string>"
        }
      ],
      "warnings": [
        {
          "type": "clock_in_early",
          "punchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "errors": [
        {
          "type": "no_clock_out",
          "shiftId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "timecardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "approval": {
        "approved": true,
        "ranges": [
          {
            "startDate": "2024-11-20T07:43:34+0000",
            "endDate": "2024-11-20T07:43:34+0000"
          }
        ]
      },
      "signOff": {
        "signedOff": true,
        "ranges": [
          {
            "startDate": "2024-11-20T07:43:34+0000",
            "endDate": "2024-11-20T07:43:34+0000"
          }
        ]
      },
      "historicalCorrections": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "status": "pending",
          "changes": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "createdAt": "2024-11-20T07:43:34+0000",
              "actor": {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "name": "<string>"
              },
              "auditLogReference": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "auditLogAction": "<string>",
              "note": "<string>"
            }
          ],
          "payCodeDifference": [
            {
              "date": "2024-11-20T07:43:34+0000",
              "payCode": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "role": "<string>",
              "value": 123
            }
          ]
        }
      ],
      "totals": [
        {
          "payCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "scheduled": 123,
          "actual": 123
        }
      ],
      "historicalCorrectionTotals": [
        {
          "payCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "scheduled": 123,
          "actual": 123
        }
      ]
    }
  ],
  "cursor": "<string>"
}

GET

timekeeping

timesheet

Get Timesheets

curl --request GET \
  --url https://app.untetherlabs.com/api/v1/timekeeping/timesheet \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "startDate": "2024-11-20T07:43:34+0000",
      "endDate": "2024-11-20T07:43:34+0000",
      "payPeriodId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "scheduledShifts": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdAt": "2024-11-20T07:43:34+0000",
          "startDate": "2024-11-20T07:43:34+0000",
          "endDate": "2024-11-20T07:43:34+0000",
          "segments": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "createdAt": "2024-11-20T07:43:34+0000",
              "role": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "isBreak": false,
              "isOnCall": false,
              "type": "working",
              "startDate": "2024-11-20T07:43:34+0000",
              "endDate": "2024-11-20T07:43:34+0000",
              "labels": [
                "<string>"
              ],
              "importedId": "<string>",
              "roleImportedId": "<string>",
              "additionalInfo": "<unknown>",
              "skillRequirement": {
                "type": "equal",
                "skill": "<string>",
                "value": "<string>"
              }
            }
          ],
          "workRuleOverride": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "provider": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "team": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "note": "<string>",
          "isExternal": true
        }
      ],
      "punches": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "timecardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdAt": "2024-11-20T07:43:34+0000",
          "updatedAt": "2024-11-20T07:43:34+0000",
          "action": "clock_in",
          "state": "pending",
          "time": "2024-11-20T07:43:34+0000",
          "providerNote": "Felt sick, had to leave early.",
          "adminNote": "Adjusted to schedule.",
          "generated": false
        }
      ],
      "provider": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Bruce Wayne",
        "email": "[email protected]",
        "hireDate": "2024-11-20T07:43:34+0000",
        "status": "active",
        "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "licensedRegions": [
          "<string>"
        ],
        "employmentType": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "paySegments": [
        {
          "id": "<string>",
          "type": "paid",
          "startDate": "2024-11-20T07:43:34+0000",
          "endDate": "2024-11-20T07:43:34+0000",
          "payCodes": [
            "<string>"
          ],
          "overtime": [
            "<string>"
          ],
          "timeRanges": [
            "<string>"
          ],
          "itemId": "<string>",
          "shiftId": "<string>",
          "timecardId": "<string>",
          "workRuleOverride": "<string>",
          "role": "<string>"
        }
      ],
      "scheduledPaySegments": [
        {
          "id": "<string>",
          "type": "paid",
          "startDate": "2024-11-20T07:43:34+0000",
          "endDate": "2024-11-20T07:43:34+0000",
          "payCodes": [
            "<string>"
          ],
          "overtime": [
            "<string>"
          ],
          "timeRanges": [
            "<string>"
          ],
          "itemId": "<string>",
          "shiftId": "<string>",
          "timecardId": "<string>",
          "workRuleOverride": "<string>",
          "role": "<string>"
        }
      ],
      "warnings": [
        {
          "type": "clock_in_early",
          "punchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "errors": [
        {
          "type": "no_clock_out",
          "shiftId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "timecardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "approval": {
        "approved": true,
        "ranges": [
          {
            "startDate": "2024-11-20T07:43:34+0000",
            "endDate": "2024-11-20T07:43:34+0000"
          }
        ]
      },
      "signOff": {
        "signedOff": true,
        "ranges": [
          {
            "startDate": "2024-11-20T07:43:34+0000",
            "endDate": "2024-11-20T07:43:34+0000"
          }
        ]
      },
      "historicalCorrections": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "status": "pending",
          "changes": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "createdAt": "2024-11-20T07:43:34+0000",
              "actor": {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "name": "<string>"
              },
              "auditLogReference": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "auditLogAction": "<string>",
              "note": "<string>"
            }
          ],
          "payCodeDifference": [
            {
              "date": "2024-11-20T07:43:34+0000",
              "payCode": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "role": "<string>",
              "value": 123
            }
          ]
        }
      ],
      "totals": [
        {
          "payCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "scheduled": 123,
          "actual": 123
        }
      ],
      "historicalCorrectionTotals": [
        {
          "payCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "scheduled": 123,
          "actual": 123
        }
      ]
    }
  ],
  "cursor": "<string>"
}

Allows reading computed timesheet data for one or more providers. Timesheets are returned for any matching provider who was active during the specified date range even if they worked zero hours. These values are impacted by historical corrections, you are advised to review the Historical Corrections documentation.

Available Expansions

Show expand options

provider: Includes the entire provider object for each timesheet.
paySegments: Pay segments describe each individually worked span during the timesheet. They are the primitive unit of timekeeping data.
scheduledPaySegments: Scheduled pay segments represent the expected set of worked segments based on the schedule only, not punch data.
problems: Includes any warnings and errors for the timesheet.
approval: Includes whether the entire range is approved, and the exact sub ranges that have been approved.
signOff: Includes whether the entire range is signed off, and the exact sub ranges that have been signed off.
historicalCorrections: Includes any historical corrections which are applied to the time range of the timesheet. These are historical corrections which were made to this time range as opposed to applied to/paid out in this range.
totals: The computed totals broken down by pay code and role for the requested range.
historicalCorrectionTotals: The totals from any historical corrections which are applied to this timesheet (as opposed to corrections made to this timesheet). Historical correction totals are only available when requesting a particular pay period (by offset or exact reference).

This endpoint may have to do significant computation to generate timesheet data on-the-fly, you are advised to set appropriate timeout and consider caching the results if applicable.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

teamId

string<uuid>

providerId

string<uuid>

payPeriodId

string<uuid>

payPeriodOffset

integer | null

Optional offset from current pay period. 0 = current, 1 = next, -1 = previous.

startDate

string

Example:

"2024-11-20T07:43:34+0000"

endDate

string

Example:

"2024-11-20T07:43:34+0000"

expand

string

Available expansions: provider, paySegments, scheduledPaySegments, problems, approval, signOff, historicalCorrections, totals, historicalCorrectionTotals

See Query Parameters for more information on expansions.

pageSize

number

default:20

Required range: 1 <= x <= 200

cursor

string

Response

items

object[]

required

Show child attributes

items.providerId

string<uuid>

required

items.startDate

string

required

Example:

"2024-11-20T07:43:34+0000"

items.endDate

string

required

Example:

"2024-11-20T07:43:34+0000"

items.payPeriodId

string<uuid> | null

required

The matching pay period, or null if the range does not align to a single pay period.

items.scheduledShifts

object[]

required

Show child attributes

items.scheduledShifts.id

string<uuid>

required

items.scheduledShifts.createdAt

string

required

Example:

"2024-11-20T07:43:34+0000"

items.scheduledShifts.startDate

string

required

Example:

"2024-11-20T07:43:34+0000"

items.scheduledShifts.endDate

string

required

Example:

"2024-11-20T07:43:34+0000"

items.scheduledShifts.segments

object[]

required

The segments that make up a shift, ordered by startDate.

Show child attributes

items.scheduledShifts.segments.id

string<uuid>

required

items.scheduledShifts.segments.createdAt

string

required

Example:

"2024-11-20T07:43:34+0000"

items.scheduledShifts.segments.role

string<uuid> | null

required

The role of the shift. Can be null if the shift is pulled from an external system.

items.scheduledShifts.segments.isBreak

boolean

required

Used to denote whether or not the provider will be on break during this segment.

Example:

false

items.scheduledShifts.segments.isOnCall

boolean

required

Example:

false

items.scheduledShifts.segments.type

enum<string>

required

The type of the segment.

Available options:

working,

paid_break,

unpaid_break,

on_call

items.scheduledShifts.segments.startDate

string

required

The timestamp of when the shift starts.

Example:

"2024-11-20T07:43:34+0000"

items.scheduledShifts.segments.endDate

string

required

The timestamp of when the shift ends.

Example:

"2024-11-20T07:43:34+0000"

items.scheduledShifts.segments.labels

string[]

required

The label IDs associated with this shift segment.

items.scheduledShifts.segments.importedId

string

If a segment was created in an external system, this is the ID of the segment in that system.

items.scheduledShifts.segments.roleImportedId

string

DEPRECATED The ID of the role in the external system. Once all roles are migrated to the system, this field will be removed.

items.scheduledShifts.segments.additionalInfo

any

DEPRECATED Additional information about the segment.

items.scheduledShifts.segments.skillRequirement

object

Option 1
Option 2

Show child attributes

items.scheduledShifts.segments.skillRequirement.type

enum<string>

required

Available options:

equal

items.scheduledShifts.segments.skillRequirement.skill

string

required

Minimum string length: 1

items.scheduledShifts.segments.skillRequirement.value

string

required

items.scheduledShifts.workRuleOverride

string<uuid> | null

required

items.scheduledShifts.provider

string<uuid>

The provider of the shift. If null, the shift is an open shift.

items.scheduledShifts.team

string<uuid>

The team that the shift is associated with.

items.scheduledShifts.note

string

A note about the shift. Visible to providers.

items.scheduledShifts.isExternal

boolean

Whether the shift is on an external team.

items.punches

object[]

required

Show child attributes

items.punches.id

string<uuid>

required

items.punches.timecardId

string<uuid>

required

items.punches.providerId

string<uuid>

required

items.punches.createdAt

string

required

Example:

"2024-11-20T07:43:34+0000"

items.punches.updatedAt

string

required

Example:

"2024-11-20T07:43:34+0000"

items.punches.action

enum<string>

required

Available options:

clock_in,

clock_out,

break_start,

break_end

items.punches.state

enum<string>

required

Available options:

pending,

approved,

rejected

items.punches.time

string

required

Example:

"2024-11-20T07:43:34+0000"

items.punches.providerNote

string | null

required

Example:

"Felt sick, had to leave early."

items.punches.adminNote

string | null

required

Example:

"Adjusted to schedule."

items.punches.generated

boolean

default:false

items.provider

object

Show child attributes

items.provider.id

string<uuid>

required

items.provider.name

string | null

required

Example:

"Bruce Wayne"

items.provider.email

string

required

Example:

"[email protected]"

items.provider.hireDate

string | null

required

Example:

"2024-11-20T07:43:34+0000"

items.provider.status

enum<string>

required

Available options:

onboarding,

active,

dismissed,

inactive

Example:

"active"

items.provider.teamId

string<uuid> | null

required

items.provider.licensedRegions

string[]

required

items.provider.employmentType

string<uuid> | null

required

items.paySegments

object[]

Show child attributes

items.paySegments.id

string

required

items.paySegments.type

enum<string>

required

Available options:

paid,

unpaid,

on_call

items.paySegments.startDate

string

required

The start date of the pay segment.

Example:

"2024-11-20T07:43:34+0000"

items.paySegments.endDate

string

required

The end date of the pay segment.

Example:

"2024-11-20T07:43:34+0000"

items.paySegments.payCodes

string[]

required

items.paySegments.overtime

string[]

required

items.paySegments.timeRanges

string[]

required

items.paySegments.itemId

string | null

items.paySegments.shiftId

string | null

items.paySegments.timecardId

string | null

items.paySegments.workRuleOverride

string | null

items.paySegments.role

string | null

items.scheduledPaySegments

object[]

Show child attributes

items.scheduledPaySegments.id

string

required

items.scheduledPaySegments.type

enum<string>

required

Available options:

paid,

unpaid,

on_call

items.scheduledPaySegments.startDate

string

required

The start date of the pay segment.

Example:

"2024-11-20T07:43:34+0000"

items.scheduledPaySegments.endDate

string

required

The end date of the pay segment.

Example:

"2024-11-20T07:43:34+0000"

items.scheduledPaySegments.payCodes

string[]

required

items.scheduledPaySegments.overtime

string[]

required

items.scheduledPaySegments.timeRanges

string[]

required

items.scheduledPaySegments.itemId

string | null

items.scheduledPaySegments.shiftId

string | null

items.scheduledPaySegments.timecardId

string | null

items.scheduledPaySegments.workRuleOverride

string | null

items.scheduledPaySegments.role

string | null

items.warnings

object[]

Show child attributes

items.warnings.type

enum<string>

required

Available options:

clock_in_early,

clock_out_early,

clock_in_late,

clock_out_late,

missing_shift

items.warnings.punchId

string<uuid>

required

items.errors

object[]

Show child attributes

items.errors.type

enum<string>

required

Available options:

no_clock_out,

invalid_shift,

missing_timecard,

missing_pay_period_template

items.errors.shiftId

string<uuid>

items.errors.timecardId

string<uuid>

items.approval

object

Show child attributes

items.approval.approved

boolean

required

items.approval.ranges

object[]

required

Show child attributes

items.approval.ranges.startDate

string

required

Example:

"2024-11-20T07:43:34+0000"

items.approval.ranges.endDate

string

required

Example:

"2024-11-20T07:43:34+0000"

items.signOff

object

Show child attributes

items.signOff.signedOff

boolean

required

items.signOff.ranges

object[]

required

Show child attributes

items.signOff.ranges.startDate

string

required

Example:

"2024-11-20T07:43:34+0000"

items.signOff.ranges.endDate

string

required

Example:

"2024-11-20T07:43:34+0000"

items.historicalCorrections

object[]

Show child attributes

items.historicalCorrections.id

string<uuid>

required

items.historicalCorrections.status

enum<string>

required

Available options:

pending,

completed

items.historicalCorrections.changes

object[]

required

Show child attributes

items.historicalCorrections.changes.id

string<uuid>

required

items.historicalCorrections.changes.createdAt

string

required

Example:

"2024-11-20T07:43:34+0000"

items.historicalCorrections.changes.actor

object

required

A null actor indicates a system-generated change

Show child attributes

items.historicalCorrections.changes.actor.id

string<uuid>

required

items.historicalCorrections.changes.actor.name

string

required

items.historicalCorrections.changes.auditLogReference

string<uuid> | null

required

A null audit log reference indicates a manually triggered historical correction

items.historicalCorrections.changes.auditLogAction

string | null

required

The action associated with the audit log reference. Will be null if there is no audit log reference.

items.historicalCorrections.changes.note

string

items.historicalCorrections.payCodeDifference

object[]

required

Show child attributes

items.historicalCorrections.payCodeDifference.date

string

required

Always represents the start of the day.

Example:

"2024-11-20T07:43:34+0000"

items.historicalCorrections.payCodeDifference.payCode

string<uuid>

required

items.historicalCorrections.payCodeDifference.role

string | null

required

items.historicalCorrections.payCodeDifference.value

number

required

The difference in minutes (may be negative)

items.totals

object[]

Show child attributes

items.totals.payCodeId

string<uuid>

required

items.totals.roleId

string<uuid> | null

required

The role worked during this time, or null for non-working time.

items.totals.scheduled

number

required

The number of minutes scheduled for this pay code and role.

items.totals.actual

number

required

The number of minutes actually worked for this pay code and role.

items.historicalCorrectionTotals

object[]

Show child attributes

items.historicalCorrectionTotals.payCodeId

string<uuid>

required

items.historicalCorrectionTotals.roleId

string<uuid> | null

required

The role worked during this time, or null for non-working time.

items.historicalCorrectionTotals.scheduled

number

required

The number of minutes scheduled for this pay code and role.

items.historicalCorrectionTotals.actual

number

required

The number of minutes actually worked for this pay code and role.

cursor

string

Get Request Create Timecard Punch

⌘I

V1

Authorizations

Query Parameters

Response