VOvoucherifyio
Customers

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

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v1/customers/{customerId}/segments
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or OAuth 2
      Implicit: https://api.voucherify.io/v1/oauth/token
      Scopes: api, customers

Response

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

objectstring required

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

data_refstring required

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

totalinteger required

Total number of segments the customer belongs to.

Example response

{
  "data": [
    {
      "id": "seg_DNAOhUtJffvX0f57ajLMFBYR"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.