Square API
You are viewing an old version of the API
Customers
Square API
Create and manage customer profiles, save cards on file for customers, and sync CRM systems with Square.
The Customers API enables you to create and manage customer profiles, as well as search for customers based on various criteria (including customer group membership). You can also use the API to save cards on file for customers to streamline future transactions, for example, to enable speedier checkout without requiring the card-on-file customer to provide the credit card info again. In addition, the API allows you to sync contacts between your CRM system and Square.
Endpoints
-
List customers
GET /v2/customers - Lists customer profiles associated with a Square account.
-
Create customer
POST /v2/customers - Creates a new customer for a business, which can have associated cards on file.
-
Search customers
POST /v2/customers/search - Searches the customer profiles associated with a Square account using one or more supported query filters.
-
Delete customer
DELETE /v2/customers/{customer_id} - Deletes a customer from a business, along with any linked cards on file.
-
Retrieve customer
GET /v2/customers/{customer_id} - Returns details for a single customer.
-
Update customer
PUT /v2/customers/{customer_id} - Updates the details of an existing customer.
-
Create customer card
POST /v2/customers/{customer_id}/cards - Adds a card on file to an existing customer.
-
Delete customer card
DELETE /v2/customers/{customer_id}/cards/{card_id} - Removes a card on file from a customer.
-
Remove group from customer
DELETE /v2/customers/{customer_id}/groups/{group_id} - Removes a group membership from a customer.
BETA -
Add group to customer
PUT /v2/customers/{customer_id}/groups/{group_id} - Adds a group membership to a customer.
BETA