• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Square API

You are viewing an old version of the API
Customer Segments

Retrieve customer segments (also called smart groups) in a business account.

The Customer Segments API lets you retrieve information about the segments defined for a business. Square sellers can create customer segments in the Seller Dashboard or Point of Sale by defining filters for the segment. For example, a segment can include customers who have visited more than 10 times. Customers are automatically added to and removed from the segment over time based on this criterion.

You can inspect the customer's segment_ids property to determine which segments a customer belongs to. Then, you can use the Customer Segments API to retrieve basic details about each segment, such as the segment name and the time when it was created.

Guides: Customer Segments

Share feedback

Thanks for visiting the Square API documentation. What's on your mind?