<- Customer Segments API

Customer Segments API

All versions ->

Retrieve customer segment

GET

 /v2/customers/segments/{segment_id}

Retrieves a specific customer segment as identified by the segment_id value.

Permissions:CUSTOMERS_READ

Guide

Retrieve segment membership information for a customer

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

segment_id

string

Required

The Square-issued ID of the customer segment.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

segment

The retrieved customer segment.