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.
The identity and technical contract details declared by the specification.
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Square publishes across the network.