You are viewing an old version of the API
List and retrieve customer segments (aka smart groups) in the business account.
The Customer Segments API lets you retrieve information about segments available in the business account. You can only create a segment in the Square Dashboard or Point of Sale by defining and saving the desired filters for the segment. For example, you could define a customer segment to include customers who have visited more than 10 times. Customers will be automatically added to and removed from the segment over time based on this criterion.
You can determine if a given customer is a part of segment by inspecting the customer's
segment_ids property. With the segments' IDs, you can then use the Customer Segments API to retrieve basic details about each segment, such as the segment name and the time when it was created.