Square

Square Customers API

The Customers API from Square — 10 operation(s) for customers.

Documentation GitHub OpenAPI

Business capability

Operations 14

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/customers List customer profiles · Square List Customers #

Ask an LLM

“How do I page through every customer profile in my Square account?”

“Can I sort my customer list by creation date or name?”

Tell an agent

List all customers.

List customers sorted by {sort_field} in {sort_order} order.

POST /v2/customers Create a customer profile · Square Create Customer #

Ask an LLM

“What is the minimum info needed to add a new customer?”

“Can I store a birthday and note on a new customer profile?”

Tell an agent

Create a customer named {given_name} {family_name}.

Add a new customer with email {email_address} and phone {phone_number}.

POST /v2/customers/bulk-create Create many customer profiles at once · Square Bulk Create Customers #

Ask an LLM

“Can I import a batch of new customers in one request?”

“How do I bulk add customers from a spreadsheet?”

Tell an agent

Bulk create these customers: {customers}.

Import the new customer profiles in {customers} in one call.

POST /v2/customers/bulk-delete Delete many customer profiles at once · Square Bulk Delete Customers #

Ask an LLM

“Can I delete a list of customers in a single call?”

“How do I remove several duplicate customer profiles together?”

Tell an agent destructive · confirm first

Bulk delete customers {customer_ids}.

Remove all of these customer profiles: {customer_ids}.

POST /v2/customers/bulk-retrieve Fetch several customers by ID · Square Bulk Retrieve Customers #

Ask an LLM

“Can I look up multiple customers at once when I already have their IDs?”

“What comes back if one of the customer IDs in a batch lookup is invalid?”

Tell an agent

Retrieve customers {customer_ids} in one call.

Fetch the profiles for customer IDs {customer_ids}.

POST /v2/customers/bulk-update Update many customer profiles at once · Square Bulk Update Customers #

Ask an LLM

“Is there a way to update many customer records in one request?”

“Can I change emails for a batch of existing customers together?”

Tell an agent

Bulk update customers with {customers}.

Apply the profile changes in {customers} to those existing customers.

POST /v2/customers/search Search customers by filters · Square Search Customers #

Ask an LLM

“How do I find customers by email, phone or creation date?”

“Can I search for customers who belong to a particular group?”

Tell an agent

Search customers matching {query}.

Find customers that match the filters in {query}, up to {limit}.

DELETE /v2/customers/{customer_id} Delete one customer profile · Square Delete Customer #

Ask an LLM

“Can I delete a single customer profile permanently?”

“Which ID do I use to delete a customer created by merging profiles?”

Tell an agent destructive · confirm first

Delete customer {customer_id}.

Remove customer profile {customer_id} at version {version}.

GET /v2/customers/{customer_id} Get one customer profile · Square Retrieve Customer #

Ask an LLM

“What contact details do we have for a specific customer?”

“Can I pull up a single customer profile by ID?”

Tell an agent

Get customer {customer_id}.

Show the profile for customer {customer_id}.

PUT /v2/customers/{customer_id} Update one customer profile · Square Update Customer #

Ask an LLM

“How do I change one customer's email address or phone number?”

“Can I remove a field from a customer profile with a sparse update?”

Tell an agent

Update customer {customer_id} email to {email_address}.

Change the phone number of customer {customer_id} to {phone_number}.

POST /v2/customers/{customer_id}/cards Save a card on a customer profile · Square Create Customer Card #

Ask an LLM

“How do I save a card on file directly to a customer's profile from a card nonce?”

“Is adding a card nonce to a customer idempotent?”

Tell an agent

Add card {card_nonce} on file for customer {customer_id}.

Save card {card_nonce} to customer {customer_id} with cardholder name {cardholder_name}.

DELETE /v2/customers/{customer_id}/cards/{card_id} Remove a card from a customer profile · Square Delete Customer Card #

Ask an LLM

“How do I remove a saved card from a customer's profile?”

“Can I delete one card on file without deleting the customer?”

Tell an agent destructive · confirm first

Delete card {card_id} from customer {customer_id}.

Remove saved card {card_id} on customer {customer_id}'s profile.

DELETE /v2/customers/{customer_id}/groups/{group_id} Remove a customer from a group · Square Remove Group from Customer #

Ask an LLM

“How do I take a customer out of a customer group?”

“Can I drop one customer's group membership without deleting the group?”

Tell an agent destructive · confirm first

Remove customer {customer_id} from group {group_id}.

End customer {customer_id}'s membership in group {group_id}.

PUT /v2/customers/{customer_id}/groups/{group_id} Add a customer to a group · Square Add Group to Customer #

Ask an LLM

“Can I put a customer into an existing customer group?”

“How do I tag a customer as a member of a group like VIPs?”

Tell an agent

Add customer {customer_id} to group {group_id}.

Make customer {customer_id} a member of customer group {group_id}.

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-customers-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 Customers 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 (174 KB total) ---
# Full source: https://artifacts.apis.io/square/openapi/square-customers-api-openapi.yml

Square Customers API

Operations 14

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification