Square

Square Team API

The Team API from Square — 8 operation(s) for team.

Documentation GitHub OpenAPI

Business capability

Operations 12

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

POST /v2/team-members Add a team member · Square Create Team Member #

Ask an LLM

“How do I add a new employee to my Square team?”

“What fields are required to create a team member?”

Tell an agent

Create team member {team_member}.

Add a new staff member with the details in {team_member}.

POST /v2/team-members/bulk-create Add many team members at once · Square Bulk Create Team Members #

Ask an LLM

“Can I onboard a whole batch of new staff in one request?”

“What happens if one team member in a bulk create fails?”

Tell an agent

Bulk create team members {team_members}.

Onboard all the new hires in {team_members} at once.

POST /v2/team-members/bulk-update Update many team members at once · Square Bulk Update Team Members #

Ask an LLM

“Is there a way to update many existing team members together?”

“Does a bulk team member update stop if one record fails?”

Tell an agent

Bulk update team members with {team_members}.

Apply the changes in {team_members} to those existing staff records.

GET /v2/team-members/jobs List job titles · Square List Jobs #

Ask an LLM

“What job titles exist in my seller account?”

“Which jobs are tip eligible?”

Tell an agent

List all jobs.

Show the next page of jobs after {cursor}.

POST /v2/team-members/jobs Create a job title · Square Create Job #

Ask an LLM

“How do I create a new job title like Barista?”

“Can I mark a new job as eligible for tips?”

Tell an agent

Create job {job}.

Add a new job title defined by {job} using key {idempotency_key}.

GET /v2/team-members/jobs/{job_id} Get a job · Square Retrieve Job #

Ask an LLM

“What title and tip setting does a specific job have?”

“Can I look up one job by its ID?”

Tell an agent

Get job {job_id}.

Show details for job {job_id}.

PUT /v2/team-members/jobs/{job_id} Rename a job or change tip eligibility · Square Update Job #

Ask an LLM

“If I rename a job, do shifts and wages pick up the new title?”

“Can I turn tip eligibility off for an existing job?”

Tell an agent

Update job {job_id} with {job}.

Rename job {job_id} using the title in {job}.

POST /v2/team-members/search Search team members · Square Search Team Members #

Ask an LLM

“Which team members are active at a given location?”

“Can I find who the account owner is among my staff?”

Tell an agent

Search team members matching {query}.

Find active team members, returning up to {limit}.

GET /v2/team-members/{team_member_id} Get a team member · Square Retrieve Team Member #

Ask an LLM

“What contact info and status does a specific team member have?”

“Can I fetch one employee's team profile by ID?”

Tell an agent

Get team member {team_member_id}.

Show the profile of team member {team_member_id}.

PUT /v2/team-members/{team_member_id} Update a team member · Square Update Team Member #

Ask an LLM

“How do I change a team member's email or assigned locations?”

“Can I deactivate a staff member by updating their status?”

Tell an agent

Update team member {team_member_id} with {team_member}.

Change the details of staff member {team_member_id} to {team_member}.

GET /v2/team-members/{team_member_id}/wage-setting Get a team member's wage setting · Square Retrieve Wage Setting #

Ask an LLM

“What jobs and pay rates are assigned to a team member?”

“Is a given team member marked as overtime exempt?”

Tell an agent

Get the wage setting for team member {team_member_id}.

Show job assignments and pay for {team_member_id}.

PUT /v2/team-members/{team_member_id}/wage-setting Set a team member's jobs and pay · Square Update Wage Setting #

Ask an LLM

“How do I give a team member a raise or a new job assignment?”

“Does updating a wage setting replace the whole existing setting?”

Tell an agent

Set the wage setting for team member {team_member_id} to {wage_setting}.

Replace {team_member_id}'s job assignments and pay with {wage_setting}.

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-team-api"

All apis

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

Discovery needs no key. Ratings and market analysis are Pro.

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 Team 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 (118 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/openapi/square-team-api-openapi.yml

Square Team API

Operations 12

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification