Sign in

v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Reporting

Lists report-ready time-clock rows from the time-clock reporting view, including clock-in/clock-out times, computed shift hours, reason and clock codes, and override-audit context so callers do not need to hand-join timer entries to their reason and clock-code tags.

post/api/reporting/time-clock/list

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip.

Takeinteger

Number of records to return (maximum)

Request body

startedFromstring date-time nullable

Inclusive lower bound applied to the entry's clock-in time (Started). Null means no lower bound.

startedTostring date-time nullable

Inclusive upper bound applied to the entry's clock-in time (Started); the whole to day is included. Null means no upper bound.

employeestring nullable

Optional exact-match filter on the operator / employee name. Null means no employee filter.

typestring nullable

Optional exact-match filter on the timer-entry type (ClockIn or Break). Null means no type filter.

Response

A page of time-clock report rows with the total matching count.

pageinteger required

The 1-indexed page

pageSizeinteger required

The page size

totalCountinteger required

The total count of records

totalPagesinteger required

The total pages

hasPreviousPageboolean required

True if there is a previous page

hasNextPageboolean required

True if there is a next page