Customer APIs

The Square Developer platform provides customer APIs to build applications that help sellers grow their businesses through strong customer relationships. Use the customer APIs to securely manage customer data, analyze buying behavior, and integrate engagement features to increase repeat business and attract new customers.

Link to section

Build with customer APIs

Use the following APIs to integrate customer management and engagement features in your application.

icon

Customers API

Manage customer profiles and group membership, search the directory, and sync records with CRM systems.

icon

Customer Custom Attributes API

Define custom properties for customer profiles to unlock customization scenarios.

icon

Customer Groups API

Create groups to enable scoped promotions at scale and actions based on group membership.

icon

Customer Segments API

Get basic details about segments that filter customers by buying behavior and other traits.

icon

Loyalty API

Create accounts and promotions and let buyers earn points and redeem reward discounts.

icon

Gift Cards API

Create and activate gift cards, reload card balances, and track gift card activities.

icon

Customers API

Manage customer profiles and group membership, search the directory, and sync records with CRM systems.

icon

Customer Custom Attributes API

Define custom properties for customer profiles to unlock customization scenarios.

icon

Customer Groups API

Create groups to enable scoped promotions at scale and actions based on group membership.

icon

Customer Segments API

Get basic details about segments that filter customers by buying behavior and other traits.

icon

Loyalty API

Create accounts and promotions and let buyers earn points and redeem reward discounts.

icon

Gift Cards API

Create and activate gift cards, reload card balances, and track gift card activities.

Link to section

Customer sample applications

Get up and running quickly with Square customer APIs and see the APIs in action.

Gift Cards API Sample

Shows how to sell and reload gift cards, link customers, view activity history, and generate barcodes.

Order-Ahead Sample

Lets buyers place online orders, choose delivery options, earn loyalty points, and pay for an order.

Bookings API Sample

Checks availability and books an appointment for a customer with a team member.

Gift Cards API Sample

Shows how to sell and reload gift cards, link customers, view activity history, and generate barcodes.

Order-Ahead Sample

Lets buyers place online orders, choose delivery options, earn loyalty points, and pay for an order.

Bookings API Sample

Checks availability and books an appointment for a customer with a team member.

Link to section

Customer guides

Learn about commonly used features and tasks you can do with customer APIs.

Link to section

Square products

Sellers can access and manage customer features from a variety of Square products.

Free CRM software built into all Square payment tools where sellers can store information about their customers, analyze how they interact with the business, and engage with them.

Learn about the Customer Directory

tab-image
Link to section

Extend customers with other API groups

Combine customer features with other Square APIs to build engagements across all areas of a seller's business and see buyer trends.

icon

Payments × Customers

Link customers to payment flows, subscriptions, and invoices and take gift card payments with automatic redemption.

Payment APIs

icon

Commerce × Customers

Integrate with orders, a catalog, and bookings and use simplified flows for loyalty and gift cards.

Commerce APIs

icon

Staff × Customers

Connect regular customers with favorite team members through payments and bookings.

Staff APIs

icon

Payments × Customers

Link customers to payment flows, subscriptions, and invoices and take gift card payments with automatic redemption.

Payment APIs

icon

Commerce × Customers

Integrate with orders, a catalog, and bookings and use simplified flows for loyalty and gift cards.

Commerce APIs

icon

Staff × Customers

Connect regular customers with favorite team members through payments and bookings.

Staff APIs