v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
CustomerSegments

RetrieveCustomerSegment

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

get/v2/customers/segments/{segment_id}

Path parameters

segment_idstring required

The Square-issued ID of the customer segment.

Response

Success

Example response

{
  "segment": {
    "created_at": "2020-01-09T19:33:24.469Z",
    "id": "GMNXRZVEXNQDF.CHURN_RISK",
    "name": "Lapsed",
    "updated_at": "2020-04-13T23:01:13Z"
  }
}