Square

Square Labor API

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

Documentation GitHub OpenAPI

Business capability

Operations 16

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v2/labor/break-types List break types for a business · Square List Break Types #

Ask an LLM

“What kinds of breaks have we set up for staff at each location?”

“Can I see only the break templates defined for one location?”

Tell an agent

List all break types.

Show the break types configured at location {location_id}.

POST /v2/labor/break-types Create a break type template · Square Create Break Type #

Ask an LLM

“How do I set up a new paid or unpaid break template for employees?”

“What do I need to define a new break type, like a 30-minute lunch?”

Tell an agent

Create a new break type from {break_type}.

Add a lunch break template described by {break_type} for our staff.

DELETE /v2/labor/break-types/{id} Delete a break type · Square Delete Break Type #

Ask an LLM

“Can I remove a break type even if shifts already reference it?”

“How do I get rid of a break template we no longer use?”

Tell an agent destructive · confirm first

Delete break type {id}.

Remove the break template {id} from our labor setup.

GET /v2/labor/break-types/{id} Get a single break type · Square Get Break Type #

Ask an LLM

“What are the settings of one specific break type?”

“Can I look up the expected duration of a break template by its ID?”

Tell an agent

Get break type {id}.

Show me the details of break template {id}.

PUT /v2/labor/break-types/{id} Update a break type template · Square Update Break Type #

Ask an LLM

“Can I change the name or length of an existing break type?”

“How do I make an existing break template paid instead of unpaid?”

Tell an agent

Update break type {id} with {break_type}.

Change break template {id} to match {break_type}.

GET /v2/labor/employee-wages List employee wages (legacy) · Square List Employee Wages #

Ask an LLM

“Where can I see hourly wages using the older employee wage records?”

“Can I filter legacy employee wage records to one employee?”

Tell an agent

List employee wages for employee {employee_id}.

Show all legacy employee wage records.

GET /v2/labor/employee-wages/{id} Get a legacy employee wage record · Square Get Employee Wage #

Ask an LLM

“What does a single legacy EmployeeWage record contain?”

“Can I fetch one employee wage entry by its ID?”

Tell an agent

Get employee wage {id}.

Show legacy employee wage record {id}.

POST /v2/labor/shifts Record a new shift for a team member · Square Create Shift #

Ask an LLM

“How do I log a workday for a team member at a location?”

“What is required to create a shift with a start time?”

Tell an agent

Create a shift from {shift}.

Log a new timecard shift for a team member using {shift}.

POST /v2/labor/shifts/search Search shifts by team member, location or status · Square Search Shifts #

Ask an LLM

“Which shifts are still open right now across my locations?”

“Can I find all shifts a team member worked in a date range?”

Tell an agent

Search shifts matching {query}.

Find open shifts, returning at most {limit}.

DELETE /v2/labor/shifts/{id} Delete a shift · Square Delete Shift #

Ask an LLM

“Can I remove a shift that was recorded by mistake?”

“What happens when I delete a timecard shift?”

Tell an agent destructive · confirm first

Delete shift {id}.

Remove the mistaken shift {id}.

GET /v2/labor/shifts/{id} Get a single shift · Square Get Shift #

Ask an LLM

“What are the start, end and break details of one shift?”

“Can I retrieve a specific timecard shift by ID?”

Tell an agent

Get shift {id}.

Show the breaks and wage on shift {id}.

PUT /v2/labor/shifts/{id} Update or close a shift · Square Update Shift #

Ask an LLM

“How do I clock someone out by closing their shift?”

“Can I add a break to a shift that is already in progress?”

Tell an agent

Update shift {id} with {shift}.

Close shift {id} by setting its end time in {shift}.

GET /v2/labor/team-member-wages List team member wages · Square List Team Member Wages #

Ask an LLM

“What hourly rates are team members paid for their jobs?”

“Can I see the wages for just one team member?”

Tell an agent

List team member wages for {team_member_id}.

Show every team member wage record.

GET /v2/labor/team-member-wages/{id} Get a team member wage record · Square Get Team Member Wage #

Ask an LLM

“How can I see the pay rate on one specific team member wage entry?”

“Which job title and hourly rate belong to a given wage record?”

Tell an agent

Get team member wage {id}.

Show hourly rate and job for team member wage {id}.

GET /v2/labor/workweek-configs List workweek configurations · Square List Workweek Configs #

Ask an LLM

“When does our business workweek start for overtime purposes?”

“Which workweek configuration is Square using for my account?”

Tell an agent

List workweek configs.

Show the workweek start day and time, up to {limit} configs.

PUT /v2/labor/workweek-configs/{id} Change the workweek start · Square Update Workweek Config #

Ask an LLM

“Can I change the day our workweek begins?”

“How do I move the workweek start time for overtime calculations?”

Tell an agent

Update workweek config {id} with {workweek_config}.

Set workweek config {id} to start on the day in {workweek_config}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/square:square-labor-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: '2.0'
  title: Square Labor API
  description: Supercharge Square for sellers of every size. Our entire connected commerce platform from elegant hardware to a rich suite of Square APIs is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen.
  termsOfService: https://connect.squareup.com/tos
  contact:
    name: Square Developer Platform
    email: developers@squareup.com
    url: https://squareup.com/developers
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  externalDocs:
    description: 'Read the official documentation here:'
    url: https://docs.connect.squareup.com/
  x-server-configuration:
    default-environment: production
    default-server: default
    environments:
    - name: production
      servers:
      - name: default
        url: https://connect.squareup.com
    - name: sandbox
      servers:
      - name: default
        url: https://connect.squareupsandbox.com
    - name: custom
      servers:
      - name: default
        url: '{custom_url}'
    parameters:
    - name: custom_url
      description: Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
      type: string
      example: https://connect.squareup.com
  x-square-generic-error-codes:
  - ACCESS_TOKEN_EXPIRED
  - ACCESS_TOKEN_REVOKED
  - API_VERSION_INCOMPATIBLE
  - APPLICATION_DISABLED
  - ARRAY_EMPTY
  - ARRAY_LENGTH_TOO_LONG
  - ARRAY_LENGTH_TOO_SHORT
  - BAD_CERTIFICATE
  - BAD_GATEWAY
  - BAD_REQUEST
  - CONFLICT
  - CONFLICTING_PARAMETERS
  - CURRENCY_MISMATCH
  - EXPECTED_ARRAY
  - EXPECTED_BASE64_ENCODED_BYTE_ARRAY
  - EXPECTED_BOOLEAN
  - EXPECTED_FLOAT
  - EXPECTED_INTEGER
  - EXPECTED_JSON_BODY
  - EXPECTED_MAP
  - EXPECTED_OBJECT
  - EXPECTED_STRING
  - FORBIDDEN
  - GATEWAY_TIMEOUT
  - GONE
  - IDEMPOTENCY_KEY_REUSED
  - INCORRECT_TYPE
  - INSUFFICIENT_SCOPES
  - INTERNAL_SERVER_ERROR
  - INVALID_ARRAY_VALUE
  - INVALID_CONTENT_TYPE
  - INVALID_CURSOR
  - INVALID_ENUM_VALUE
  - INVALID_FORM_VALUE
  - INVALID_SORT_ORDER
  - INVALID_SQUARE_VERSION_FORMAT
  - INVALID_TIME
  - INVALID_TIME_RANGE
  - INVALID_VALUE
  - LOCATION_MISMATCH
  - MAP_KEY_LENGTH_TOO_LONG
  - MAP_KEY_LENGTH_TOO_SHORT
  - MERCHANT_SUBSCRIPTION_NOT_FOUND
  - METHOD_NOT_ALLOWED
  - MISSING_REQUIRED_PARAMETER
  - NOT_ACCEPTABLE
  - NOT_FOUND
  - NOT_IMPLEMENTED
  - NO_FIELDS_SET
  - RATE_LIMITED
  - REQUEST_ENTITY_TOO_LARGE
  - REQUEST_TIMEOUT
  - SANDBOX_NOT_SUPPORTED
  - SERVICE_UNAVAILABLE
  - TOO_MANY_MAP_ENTRIES
  - UNAUTHORIZED
  - UNEXPECTED_VALUE
  - UNKNOWN_BODY_PARAMETER
  - UNKNOWN_QUERY_PARAMETER
  - UNPROCESSABLE_ENTITY
  - UNSUPPORTED_MEDIA_TYPE
  - V1_ACCESS_TOKEN
  - V1_APPLICATION
  - VALUE_EMPTY
  - VALUE_REGEX_MISMATCH
  - VALUE_TOO_HIGH
  - VALUE_TOO_LONG
  - VALUE_TOO_LOW
  - VALUE_TOO_SHORT
servers:
- url: https://connect.squareup.com
  variables: {}
tags:


# --- truncated at 32 KB (122 KB total) ---
# Full source: https://artifacts.apis.io/square/openapi/square-labor-api-openapi.yml

Square Labor API

Operations 16

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification