List Customer's Segments

Returns the list of segments IDs to which the customer belongs to.

If you pass a customerId which is not stored and recognized by Voucherify as an existing customer in the system, the response will generate a list of segments that the customer would potentialy qualify for if they were to become a customer tracked in the system.

GET /v1/customers/{customerId}/segments

List Customer's Segments

cURL

curl --request GET \
  --url https://{cluster}.voucherify.io/v1/customers/{customerId}/segments \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "id": "seg_DNAOhUtJffvX0f57ajLMFBYR",
      "name": "area code not 123",
      "object": "segment"
    },
    {
      "id": "seg_IPIYx96l92Op0Sy5MOaImhgw",
      "name": "not [e-mail]",
      "object": "segment"
    },
    {
      "id": "seg_1wc52c5z6r1kQ81brO8j9Hk2",
      "name": "Birthday After Dec 31",
      "object": "segment"
    },
    {
      "id": "seg_ZEbbT4mq1ePpM9PzR02lcww2",
      "name": "Start with S",
      "object": "segment"
    },
    {
      "id": "seg_WJv55MbzQwnr56ttJ2xUrSgt",
      "name": "Loyalty Card",
      "object": "segment"
    }
  ],
  "total": 5
}

Authorizations

X-App-Id & X-App-TokenX-Voucherify-OAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

customerId · string · required

Unique identifier of a customer represented by an internal customer ID or customer source ID.

Example:

"cust_nk0N1uNQ1YnupAoJGOgvsODC"

Response

200 - application/json

The method returns segment(s) to which the given customer belongs to.

Response body schema for GET v1/customers/{customerId}/segments.

object · string · default: list · required

The type of the object represented by JSON. This object stores information about customer segments.

data_ref · string · default: data · required

Identifies the name of the JSON property that contains the array of segment IDs.

data · Simple Segment · object[] · required

A dictionary that contains an array of segment IDs and names.

Show child attributes

total · integer · required

Total number of segments the customer belongs to.