Square API
You are viewing an old version of the API
Labor
Square API
Manage shifts, breaks, and wages for employees in Square POS
The Labor API allows you to see when employees clocked in and out, how much they worked during different periods, and how many breaks they took. You can also call the API to register a past break, adjust a shift, or update a wage.
This API is best used in conjunction with the Employees API.
-
List break types
GET /v2/labor/break-types - Returns a paginated list of BreakType instances for a business.
-
Create break type
POST /v2/labor/break-types - Creates a new BreakType.
-
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.
-
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.
-
Get shift
GET /v2/labor/shifts/{id} - Returns a single Shift specified by id.
-
Update shift
PUT /v2/labor/shifts/{id} - Updates an existing Shift.
-
List team member wages
GET /v2/labor/team-member-wages - Returns a paginated list of TeamMemberWage instances for a business.
-
Get team member wage
GET /v2/labor/team-member-wages/{id} - Returns a single TeamMemberWage specified by id.
-
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.