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

You are viewing an old version of the API
Retrieve customer segment BETA

GET /v2/customers/segments/{segment_id}

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


Permissions
CUSTOMERS_READ
Try in API Explorer
Name Description
segment_id
string

Required

The Square-issued ID of the customer segment.

Response Fields

Name Description
errors
Error [ ]

Any errors that occurred during the request.

segment
CustomerSegment

The retrieved customer segment.

Examples

You are viewing an old version of the API
GET /v2/customers/segments/{segment_id}
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
curl https://connect.squareup.com/v2/customers/segments/GMNXRZVEXNQDF.CHURN_RISK \
  -H 'Square-Version: 2020-08-26' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "segment": {
    "id": "GMNXRZVEXNQDF.CHURN_RISK",
    "name": "Lapsed",
    "created_at": "2020-01-09T19:33:24.469Z",
    "updated_at": "2020-04-13T23:01:13Z"
  }
}

Share Feedback

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