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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Square

Square Customers API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Square Customers 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 Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 14 operations across 10 paths, and defines 53 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.

14 operations 10 paths 53 schemas 3 DELETE2 GET7 POST2 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
Contact
Square Developer Platform
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Square Customers 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 14

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

Customers 14
GET
/v2/customers
Square List Customers
ListCustomers 5 params → 200
POST
/v2/customers
Square Create Customer
CreateCustomer body → 200
POST
/v2/customers/bulk-create
Square Bulk Create Customers
BulkCreateCustomers body → 200
POST
/v2/customers/bulk-delete
Square Bulk Delete Customers
BulkDeleteCustomers body → 200
POST
/v2/customers/bulk-retrieve
Square Bulk Retrieve Customers
BulkRetrieveCustomers body → 200
POST
/v2/customers/bulk-update
Square Bulk Update Customers
BulkUpdateCustomers body → 200
POST
/v2/customers/search
Square Search Customers
SearchCustomers body → 200
DELETE
/v2/customers/{customer_id}
Square Delete Customer
DeleteCustomer 2 params → 200
GET
/v2/customers/{customer_id}
Square Retrieve Customer
RetrieveCustomer 1 param → 200
PUT
/v2/customers/{customer_id}
Square Update Customer
UpdateCustomer 1 param body → 200
POST
/v2/customers/{customer_id}/cardsdeprecated
Square Create Customer Card
CreateCustomerCard 1 param body → 200
DELETE
/v2/customers/{customer_id}/cards/{card_id}deprecated
Square Delete Customer Card
DeleteCustomerCard 2 params → 200
DELETE
/v2/customers/{customer_id}/groups/{group_id}
Square Remove Group from Customer
RemoveGroupFromCustomer 2 params → 200
PUT
/v2/customers/{customer_id}/groups/{group_id}
Square Add Group to Customer
AddGroupToCustomer 2 params → 200

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are Customer (19 properties), Card (17 properties), Address (14 properties), CreateCustomerRequest (12 properties). Each schema is shown below with its type and property counts.

CardBrand
string
Indicates a card's brand, such as VISA or MASTERCARD.
CardType
string
Indicates a card's type, such as CREDIT or DEBIT.
CreateCustomerResponse
object
Defines the fields that are included in the response body of a request to the [CreateCustomer](api-endpoint:Customers-CreateCustomer) or [BulkCreateCustomers](…
2 properties
BulkUpdateCustomersResponse
object
Defines the fields included in the response body from the [BulkUpdateCustomers](api-endpoint:Customers-BulkUpdateCustomers) endpoint.
2 properties
CardPrepaidType
string
Indicates a card's prepaid type, such as NOTPREPAID or PREPAID.
CustomerPreferences
object
Represents communication preferences for the customer profile.
1 property
Country
string
Indicates the country associated with another entity, such as a business. Values are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/count…
BulkUpdateCustomersRequest
object
Defines the body parameters that can be included in requests to the [BulkUpdateCustomers](api-endpoint:Customers-BulkUpdateCustomers) endpoint.
1 property 1 required
SearchCustomersResponse
object
Defines the fields that are included in the response body of a request to the SearchCustomers endpoint. Either errors or customers is present in a given respon…
4 properties
CustomerAddressFilter
object
The customer address filter. This filter is used in a [CustomerCustomAttributeFilterValue](entity:CustomerCustomAttributeFilterValue) filter when searching by…
2 properties
CustomerSortField
string
Specifies customer attributes as the sort key to customer profiles returned from a search.
BulkRetrieveCustomersRequest
object
Defines the body parameters that can be included in requests to the [BulkRetrieveCustomers](api-endpoint:Customers-BulkRetrieveCustomers) endpoint.
1 property 1 required
DeleteCustomerCardResponse
object
Defines the fields that are included in the response body of a request to the DeleteCustomerCard endpoint.
1 property
CustomerSort
object
Represents the sorting criteria in a [search query](entity:CustomerQuery) that defines how to sort customer profiles returned in [SearchCustomers](api-endpoint…
2 properties
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
CustomerCustomAttributeFilter
object
The custom attribute filter. Use this filter in a set of [custom attribute filters](entity:CustomerCustomAttributeFilters) to search based on the value or last…
3 properties 1 required
CustomerCreationSourceFilter
object
The creation source filter. If one or more creation sources are set, customer profiles are included in, or excluded from, the result if they match at least one…
2 properties
SortOrder
string
The order (e.g., chronological or alphabetical) in which results from a request are returned.
CustomerInclusionExclusion
string
Indicates whether customers should be included in, or excluded from, the result set when they match the filtering criteria.
RemoveGroupFromCustomerResponse
object
Defines the fields that are included in the response body of a request to the [RemoveGroupFromCustomer](api-endpoint:Customers-RemoveGroupFromCustomer) endpoin…
1 property
Address
object
Represents a postal address in a country. For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addr…
14 properties
SearchCustomersRequest
object
Defines the fields that are included in the request body of a request to the SearchCustomers endpoint.
4 properties
DeleteCustomerResponse
object
Defines the fields that are included in the response body of a request to the DeleteCustomer endpoint.
1 property
FloatNumberRange
object
Specifies a decimal number range.
2 properties
CreateCustomerRequest
object
Defines the body parameters that can be included in a request to the CreateCustomer endpoint.
12 properties
ListCustomersResponse
object
Defines the fields that are included in the response body of a request to the ListCustomers endpoint. Either errors or customers is present in a given response…
4 properties
CreateCustomerCardRequest
object
Defines the fields that are included in the request body of a request to the CreateCustomerCard endpoint.
4 properties 1 required
CustomerQuery
object
Represents filtering and sorting criteria for a [SearchCustomers](api-endpoint:Customers-SearchCustomers) request.
2 properties
BulkDeleteCustomersResponse
object
Defines the fields included in the response body from the [BulkDeleteCustomers](api-endpoint:Customers-BulkDeleteCustomers) endpoint.
2 properties
CustomerFilter
object
Represents the filtering criteria in a [search query](entity:CustomerQuery) that defines how to filter customer profiles returned in [SearchCustomers](api-endp…
9 properties
CardCoBrand
string
Indicates the brand for a co-branded card.
BulkDeleteCustomersRequest
object
Defines the body parameters that can be included in requests to the [BulkDeleteCustomers](api-endpoint:Customers-BulkDeleteCustomers) endpoint.
1 property 1 required
CustomerTextFilter
object
A filter to select customers based on exact or fuzzy matching of customer attributes against a specified query. Depending on the customer attributes, the filte…
2 properties
BulkCreateCustomersRequest
object
Defines the body parameters that can be included in requests to the [BulkCreateCustomers](api-endpoint:Customers-BulkCreateCustomers) endpoint.
1 property 1 required
BulkRetrieveCustomersResponse
object
Defines the fields included in the response body from the [BulkRetrieveCustomers](api-endpoint:Customers-BulkRetrieveCustomers) endpoint.
2 properties
CustomerCustomAttributeFilterValue
object
A type-specific filter used in a [custom attribute filter](entity:CustomerCustomAttributeFilter) to search based on the value of a customer-related [custom att…
8 properties
AddGroupToCustomerResponse
object
Defines the fields that are included in the response body of a request to the [AddGroupToCustomer](api-endpoint:Customers-AddGroupToCustomer) endpoint.
1 property
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.
UpdateCustomerRequest
object
Defines the body parameters that can be included in a request to the UpdateCustomer endpoint.
12 properties
Customer
object
Represents a Square customer profile in the Customer Directory of a Square seller.
19 properties
BulkCreateCustomerData
object
Defines the customer data provided in individual create requests for a [BulkCreateCustomers](api-endpoint:Customers-BulkCreateCustomers) operation.
11 properties
UpdateCustomerResponse
object
Defines the fields that are included in the response body of a request to the [UpdateCustomer](api-endpoint:Customers-UpdateCustomer) or [BulkUpdateCustomers](…
2 properties
FilterValue
object
A filter to select resources based on an exact field value. For any given value, the value can only be in one property. Depending on the field, either all prop…
3 properties
BulkCreateCustomersResponse
object
Defines the fields included in the response body from the [BulkCreateCustomers](api-endpoint:Customers-BulkCreateCustomers) endpoint.
2 properties
CustomerTaxIds
object
Represents the tax ID associated with a [customer profile](entity:Customer). The corresponding taxids field is available only for customers of sellers in EU co…
1 property
Card
object
Represents the payment details of a card to be used for payments. These details are determined by the payment token generated by Web Payments SDK.
17 properties
RetrieveCustomerResponse
object
Defines the fields that are included in the response body of a request to the RetrieveCustomer endpoint. Either errors or customer is present in a given respon…
2 properties
BulkUpdateCustomerData
object
Defines the customer data provided in individual update requests for a [BulkUpdateCustomers](api-endpoint:Customers-BulkUpdateCustomers) operation.
12 properties
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
CreateCustomerCardResponse
object
Defines the fields that are included in the response body of a request to the CreateCustomerCard endpoint. Either errors or card is present in a given response…
2 properties
CustomerCreationSource
string
Indicates the method used to create the customer profile.
CustomerCustomAttributeFilters
object
The custom attribute filters in a set of [customer filters](entity:CustomerFilter) used in a search query. Use this filter to search based on [custom attribute…
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

square-customers-api-openapi.yml Raw ↑

Other APIs Square publishes across the network.

Square Reporting API
AE Profile APIs.io
Square Channels API
AE Profile APIs.io
Square Transfer Orders API
AE Profile APIs.io
Square ApplePay API
AE Profile APIs.io
Square BankAccounts API
AE Profile APIs.io
Square BookingCustomAttributes API
AE Profile APIs.io
Square Bookings API
AE Profile APIs.io
Square Cards API
AE Profile APIs.io
Square CashDrawers API
AE Profile APIs.io
Square Catalog API
AE Profile APIs.io
Square Checkout API
AE Profile APIs.io
Square CustomerCustomAttributes API
AE Profile APIs.io
#Customers
← Back to S APIs
API Details
ID
square:square-customers-api
Server
https://connect.squareup.com
Docs
https://developer.squareup.com/docs/payments-overview
Provider
Square
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=square-customers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/square-customers-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Square Customers 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.