Square API

You are viewing an old version of the API

2019-11-20

Version 2019-11-20

• All Versions

Square API

Labor

Endpoints

You are viewing an old version of the API

2019-11-20

Version 2019-11-20

• All Versions

• Get shift

  GET /v2/labor/shifts/{id} - Returns a single Shift specified by id

• List break types

  GET /v2/labor/break-types - Returns a paginated list of BreakType instances for a business

• Delete break type

  DELETE /v2/labor/break-types/{id} - Deletes an existing BreakType

• Get break type

  GET /v2/labor/break-types/{id} - Returns a single BreakType specified by id

• Update break type

  PUT /v2/labor/break-types/{id} - Updates an existing BreakType

• List employee wages

  GET /v2/labor/employee-wages - Returns a paginated list of EmployeeWage instances for a business

• Get employee wage

  GET /v2/labor/employee-wages/{id} - Returns a single EmployeeWage specified by id

• Create shift

  POST /v2/labor/shifts - Creates a new Shift

• Search shifts

  POST /v2/labor/shifts/search - Returns a paginated list of Shift records for a business

• Delete shift

  DELETE /v2/labor/shifts/{id} - Deletes a Shift

• Create break type

  POST /v2/labor/break-types - Creates a new BreakType

• Update shift

  PUT /v2/labor/shifts/{id} - Updates an existing Shift

• List workweek configs

  GET /v2/labor/workweek-configs - Returns a list of WorkweekConfig instances for a business

• Update workweek config

  PUT /v2/labor/workweek-configs/{id} - Updates a WorkweekConfig

V1 Endpoints

Some operations require use of Connect V1 endpoints. See When to use Connect V1 to learn more.

• Create timecard

  POST /v1/me/timecards - Creates a timecard for an employee and clocks them in with an API_CREATE event and a clockin_time set to the current time unless the request provides a different value

  V1

• Delete timecard

  DELETE /v1/me/timecards/{timecard_id} - Deletes a timecard

  V1

• List timecards

  GET /v1/me/timecards - Provides summary information for all of a business's employee timecards

  V1

• List timecard events

  GET /v1/me/timecards/{timecard_id}/events - Provides summary information for all events associated with a particular timecard

  V1

• Retrieve timecard

  GET /v1/me/timecards/{timecard_id} - Provides the details for a single timecard

  V1

• Update timecard

  PUT /v1/me/timecards/{timecard_id} - Modifies the details of a timecard with an API_EDIT event for the timecard

  V1