You are viewing an old version of the API
List timecards
V1

Note We recommend using the Square API (V2) for all new development when possible.

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

Required permissions TIMECARDS_READ

Query Parameters

Name Description
order
string

The order in which timecards are listed in the response, based on their created_at field.

employee_id
string

If provided, the endpoint returns only timecards for the employee with the specified ID.

begin_clockin_time
string

If filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format.

end_clockin_time
string

If filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format.

begin_clockout_time
string

If filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format.

end_clockout_time
string

If filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format.

begin_updated_at
string

If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format.

end_updated_at
string

If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format.

deleted
boolean

If 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.

limit
integer

The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.

batch_token
string

A pagination cursor to retrieve the next set of results for your original query to the endpoint.

Response Fields

Name Description
{items}
V1​Timecard [ ]

Root array of on V1Timecard objects on the response

Examples

You are viewing an old version of the API
GET /v1/me/timecards
cURL
  • cURL
curl https://connect.squareup.com/v1/me/timecards \
  -H 'Authorization: Bearer ACCESS_TOKEN'

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?