Skip to main content
GET
/
v1
/
segments
/
{segmentId}
Get Segment
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/segments/{segmentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "id": "seg_Mv5w1b2FIEbiCCO5ioT8TfI2",
  "name": "Tiers 2 - Senior",
  "created_at": "2022-06-09T13:21:26.656Z",
  "type": "auto-update",
  "filter": {
    "junction": "and",
    "loyalty_points.campaigns.Tiers 2.points": {
      "conditions": {
        "$more_than_equal": [
          41
        ]
      }
    }
  },
  "initial_sync_status": "DONE",
  "object": "segment"
}

Authorizations

X-App-Id
string
header
required
X-App-Token
string
header
required
Authorization
string
header
required

Path Parameters

segmentId
string
required
Example:

Response

id
string
Example:
name
string
created_at
string<date-time>
Example:
type
enum<string>
Available options:
auto-update,
passive,
static
filter
object | null
object
enum<string>
default:segment
Available options:
segment