COconnecteam
Time Clock:v1:TimeClocks:TimeClock:TimeActivities

Get time activities

Changed on

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

Request

  • Base URL
    https://api.connecteam.com
  • URL
    https://api.connecteam.com/time-clock/v1/time-clocks/{timeClockId}/time-activities
  • Auth
    • API key in header X-API-KEY
    • or OAuth 2
      Client credentials
      Token URL: /oauth/v1/token scopes: time_clock.read

Path parameters

timeClockIdinteger required

The unique identifier of the time clock

Query parameters

startDatestring required

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)

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.

jobIdsstring[]

The job IDs of shifts

manualBreakIdsstring[]

The manual break IDs of manual breaks

policyTypeIdsstring[]

The policy type IDs of time offs

activityTypesTimeActivityType[]

The time activity types: shift, manual_break or time_off

Response

Successful Response

requestIdstring

Changes

  • a01dde7c27fbRevision changes
    • warning

      added the new breakAutoEnd enum value to the ////////// response property for the response status

    • warning

      added the new breakAutoEnd enum value to the ////////// response property for the response status

    • warning

      added the new breakAutoEnd enum value to the ////////// response property for the response status

    • warning

      added the new breakAutoEnd enum value to the ////////// response property for the response status

    • warning

      added the new breakAutoEnd enum value to the ////////// response property for the response status

    • warning

      added the new breakAutoEnd enum value to the ////////// response property for the response status