Square API
You are viewing an old version of the API
Customers
Square API
Create and manage customer profiles 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 sync contacts between your CRM system and Square.
-
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.
-
Search customers
POST /v2/customers/search - Searches the customer profiles associated with a Square account using a supported query filter.
-
Delete customer
DELETE /v2/customers/{customer_id} - Deletes a customer profile from a business.
-
Retrieve customer
GET /v2/customers/{customer_id} - Returns details for a single customer.
-
Update customer
PUT /v2/customers/{customer_id} - Updates a customer profile.
-
Remove group from customer
DELETE /v2/customers/{customer_id}/groups/{group_id} - Removes a group membership from a customer.
-
Add group to customer
PUT /v2/customers/{customer_id}/groups/{group_id} - Adds a group membership to a customer.