Get Me Timecards

GET {{baseUrl}}/v1/me/timecards?order=<object>&employee_id=<string>&begin_clockin_time=<string>&end_clockin_time=<string>&begin_clockout_time=<string>&end_clockout_time=<string>&begin_updated_at=<string>&end_updated_at=<string>&deleted=<boolean>&limit=<integer>&batch_token=<string>

Provides summary information for all of a business's employee timecards.

Request Params

KeyDatatypeRequiredDescription
orderstringThe order in which employees are listed in the response, based on their created_at field. Default value: ASC
employee_idstringIf provided, the endpoint returns only timecards for the employee with the specified ID.
begin_clockin_timestringIf filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format.
end_clockin_timestringIf filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format.
begin_clockout_timestringIf filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format.
end_clockout_timestringIf filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format.
begin_updated_atstringIf filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format
end_updated_atstringIf filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format.
deletedstringIf true, only deleted timecards are returned. If false, only valid timecards are returned.If you don't provide this parameter, both valid and deleted timecards are returned.
limitstringThe maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
batch_tokenstringA pagination cursor to retrieve the next set of results for your
original query to the endpoint.