latestOpenAPI 3.0.02026-08-1284111344.5 KB

14666f4db0f8

TimeSheets

Retrieve a list of Time Sheets

Retrieves a paginated list of Time Sheets based on the applied filters and pagination.

get/v2/timeSheet

Query parameters

pageSizenumber

Example:10

Number of records to return per page.

pagenumber

Example:1

The page index.

techIdstring

Example:USR-81ce48127c24fd23

Filter by tech ID (prefix USR-).

jobIdstring

Example:JOB-BA5r7o4bqzR9MONa

Filter by job ID (prefix JOB-).

dateQuerystring

Example:2025-01-01_2025-12-31

Filter by start date range in the format YYYY-MM-DD_YYYY-MM-DD.

withJobboolean

When true, only returns shifts associated with a job. Ignored if jobId is provided.

Headers

Authorizationstring required

Example:Bearer <token>

Bearer Token

Response

A paginated list of Time Sheets.

pageSizenumber

The maximum number of items returned per page.

pagenumber

The current page number.

totalResultsnumber

The total number of results.

hasMoreboolean

Whether there are more results.

Example response

{
  "pageSize": 10,
  "page": 1,
  "totalResults": 50,
  "hasMore": true,
  "data": [
    {
      "id": "TS-de9750285414508f",
      "techId": "USR-81ce48127c24fd23",
      "techName": "John Doe",
      "startDate": "2024-01-24 08:00:00",
      "endDate": "2024-01-24 16:00:00",
      "notes": "This is a note",
      "jobId": "JOB-BA5r7o4bqzR9MONa",
      "laborCost": 34.75,
      "shiftLength": "08:00"
    }
  ]
}