Skip to main content
GET
/
v1
/
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",
          "version": 123,
          "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
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
​
cursor
string