Sign in

v1

latestOpenAPI 3.1.02026-07-24145580597.0 KB
Time Clock:v1:TimeClocks:TimeClock:TimeActivities

Get time activities

Retrieve a list of time activities in under a specified time clock. Time activities include shift and/or manual breaks

get/time-clock/v1/time-clocks/{timeClockId}/time-activities

Path parameters

timeClockIdinteger required

The unique identifier of the time clock

The unique identifier of the time clock

Query parameters

startDatestring required

The start time to filter by in ISO 8601 format (YYYY-MM-DD)

The start time to filter by in ISO 8601 format (YYYY-MM-DD)

endDatestring required

The end time to filter by in ISO 8601 format (YYYY-MM-DD)

The end time to filter by in ISO 8601 format (YYYY-MM-DD)

userIdsinteger[]

Filter time activities by a list of user IDs. Users who are no longer assigned to the specified time clock cannot be retrieved with this filter.

Filter time activities by a list of user IDs. Users who are no longer assigned to the specified time clock cannot be retrieved with this filter.

jobIdsstring[]

The job IDs of shifts

The job IDs of shifts

manualBreakIdsstring[]

The manual break IDs of manual breaks

The manual break IDs of manual breaks

policyTypeIdsstring[]

The policy type IDs of time offs

The policy type IDs of time offs

activityTypesTimeActivityType[]

The time activity types: shift, manual_break or time_off

The time activity types: shift, manual_break or time_off

Response

Successful Response

requestIdstring