How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Square Labor API

The Labor API from Square — 11 operation(s) for labor.

Square Labor API is one of 45 APIs that Square publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Labor. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 16 operations across 11 paths, and defines 46 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://connect.squareup.com.

16 operations 11 paths 46 schemas 2 DELETE8 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Server
https://connect.squareup.com
Authentication
OAuth 2.0, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Square Labor API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 57 scopes. An API key is passed in the header as Authorization (oauth2ClientSecret).

Paths & Operations 16

Across 11 paths, the API surfaces 16 operations — 2 DELETE, 8 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Labor 16
GET
/v2/labor/break-types
Square List Break Types
ListBreakTypes 3 params → 200
POST
/v2/labor/break-types
Square Create Break Type
CreateBreakType body → 200
DELETE
/v2/labor/break-types/{id}
Square Delete Break Type
DeleteBreakType 1 param → 200
GET
/v2/labor/break-types/{id}
Square Get Break Type
GetBreakType 1 param → 200
PUT
/v2/labor/break-types/{id}
Square Update Break Type
UpdateBreakType 1 param body → 200
GET
/v2/labor/employee-wagesdeprecated
Square List Employee Wages
ListEmployeeWages 3 params → 200
GET
/v2/labor/employee-wages/{id}deprecated
Square Get Employee Wage
GetEmployeeWage 1 param → 200
POST
/v2/labor/shifts
Square Create Shift
CreateShift body → 200
POST
/v2/labor/shifts/search
Square Search Shifts
SearchShifts body → 200
DELETE
/v2/labor/shifts/{id}
Square Delete Shift
DeleteShift 1 param → 200
GET
/v2/labor/shifts/{id}
Square Get Shift
GetShift 1 param → 200
PUT
/v2/labor/shifts/{id}
Square Update Shift
UpdateShift 1 param body → 200
GET
/v2/labor/team-member-wages
Square List Team Member Wages
ListTeamMemberWages 3 params → 200
GET
/v2/labor/team-member-wages/{id}
Square Get Team Member Wage
GetTeamMemberWage 1 param → 200
GET
/v2/labor/workweek-configs
Square List Workweek Configs
ListWorkweekConfigs 2 params → 200
PUT
/v2/labor/workweek-configs/{id}
Square Update Workweek Config
UpdateWorkweekConfig 1 param body → 200

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are Shift (14 properties), BreakType (8 properties), Break (7 properties), ShiftFilter (7 properties). Each schema is shown below with its type and property counts.

Currency
string
Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO4217).
Break
object
A record of an employee's break during a shift.
7 properties 5 required
GetShiftResponse
object
A response to a request to get a Shift. The response contains the requested Shift object and might contain a set of Error objects if the request resulted in er…
2 properties
ListTeamMemberWagesResponse
object
The response to a request for a set of TeamMemberWage objects. The response contains a set of TeamMemberWage objects.
3 properties
GetEmployeeWageResponse
object
A response to a request to get an EmployeeWage. The response contains the requested EmployeeWage objects and might contain a set of Error objects if the reques…
2 properties
ShiftFilterStatus
string
Specifies the status of Shift records to be returned.
TeamMemberWage
object
The hourly wage rate that a team member earns on a Shift for doing the job specified by the title property of this object.
6 properties
UpdateBreakTypeResponse
object
A response to a request to update a BreakType. The response contains the requested BreakType objects and might contain a set of Error objects if the request re…
2 properties
UpdateShiftRequest
object
A request to update a Shift object.
1 property 1 required
ShiftStatus
string
Enumerates the possible status of a Shift.
DateRange
object
A range defined by two dates. Used for filtering a query for Connect v2 objects that have date properties.
2 properties
UpdateWorkweekConfigResponse
object
The response to a request to update a WorkweekConfig object. The response contains the updated WorkweekConfig object and might contain a set of Error objects i…
2 properties
ListEmployeeWagesResponse
object
The response to a request for a set of EmployeeWage objects. The response contains a set of EmployeeWage objects.
3 properties
ShiftSort
object
Sets the sort order of search results.
2 properties
Money
object
Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered…
2 properties
BreakType
object
A defined break template that sets an expectation for possible Break instances on a Shift.
8 properties 4 required
TimeRange
object
Represents a generic time range. The start and end values are represented in RFC 3339 format. Time ranges are customized to be inclusive or exclusive based on…
2 properties
ShiftSortField
string
Enumerates the Shift fields to sort on.
SearchShiftsResponse
object
The response to a request for Shift objects. The response contains the requested Shift objects and might contain a set of Error objects if the request resulted…
3 properties
Shift
object
A record of the hourly rate, start, and end times for a single work shift for an employee. This might include a record of the start and end times for breaks ta…
14 properties 2 required
DeleteShiftResponse
object
The response to a request to delete a Shift. The response might contain a set of Error objects if the request resulted in errors.
1 property
SortOrder
string
The order (e.g., chronological or alphabetical) in which results from a request are returned.
ShiftFilter
object
Defines a filter used in a search for Shift records. AND logic is used by Square's servers to apply each filter property specified.
7 properties
UpdateBreakTypeRequest
object
A request to update a BreakType.
1 property 1 required
SearchShiftsRequest
object
A request for a filtered and sorted set of Shift objects.
3 properties
ShiftWorkday
object
A Shift search query filter parameter that sets a range of days that a Shift must start or end in before passing the filter condition.
3 properties
GetTeamMemberWageResponse
object
A response to a request to get a TeamMemberWage. The response contains the requested TeamMemberWage objects and might contain a set of Error objects if the req…
2 properties
UpdateShiftResponse
object
The response to a request to update a Shift. The response contains the updated Shift object and might contain a set of Error objects if the request resulted in…
2 properties
Weekday
string
The days of the week.
CreateBreakTypeRequest
object
A request to create a new BreakType.
2 properties 1 required
DeleteBreakTypeResponse
object
The response to a request to delete a BreakType. The response might contain a set of Error objects if the request resulted in errors.
1 property
CreateShiftResponse
object
The response to a request to create a Shift. The response contains the created Shift object and might contain a set of Error objects if the request resulted in…
2 properties
CreateBreakTypeResponse
object
The response to the request to create a BreakType. The response contains the created BreakType object and might contain a set of Error objects if the request r…
2 properties
ShiftWorkdayMatcher
string
Defines the logic used to apply a workday filter.
UpdateWorkweekConfigRequest
object
A request to update a WorkweekConfig object.
1 property 1 required
ShiftQuery
object
The parameters of a Shift search query, which includes filter and sort options.
2 properties
Error
object
Represents an error encountered during a request to the Connect API. See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) fo…
4 properties 2 required
ErrorCode
string
Indicates the specific error that occurred during a request to a Square API.
GetBreakTypeResponse
object
The response to a request to get a BreakType. The response contains the requested BreakType objects and might contain a set of Error objects if the request res…
2 properties
WorkweekConfig
object
Sets the day of the week and hour of the day that a business starts a workweek. This is used to calculate overtime pay.
6 properties 2 required
ListWorkweekConfigsResponse
object
The response to a request for a set of WorkweekConfig objects. The response contains the requested WorkweekConfig objects and might contain a set of Error obje…
3 properties
CreateShiftRequest
object
Represents a request to create a Shift.
2 properties 1 required
ListBreakTypesResponse
object
The response to a request for a set of BreakType objects. The response contains the requested BreakType objects and might contain a set of Error objects if the…
3 properties
EmployeeWage
object
The hourly wage rate that an employee earns on a Shift for doing the job specified by the title property of this object. Deprecated at version 2020-08-26. Use…
4 properties
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
ShiftWage
object
The hourly wage rate used to compensate an employee for this shift.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

square-labor-api-openapi.yml Raw ↑

Other APIs Square publishes across the network.

Square Reporting API
Square Channels API
Square Transfer Orders API
Square ApplePay API
Square BankAccounts API
Square BookingCustomAttributes API
Square Bookings API
Square Cards API
Square CashDrawers API
Square Catalog API
Square Checkout API
Square CustomerCustomAttributes API
Where this information came from

This is an independent, third-party profile of Square Labor API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.