Get segments for a profile
Learn more about the Segmentation Api to retrieve segments a profile is part of.
This Get Segments API retrieves a list of segments that the profile currently belongs to.
Request
GET /entities/{id}/segments| Parameter | Required | Description | |
|---|---|---|---|
| Headers | Authorization
| Yes | Information about authentication access token in the format "Bearer <accessToken>". For more information, see Authentication API. |
| Query | sort | No | Denotes the field that is used to sort the results. |
| order | No | Indicates whether the segments are sorted in ascending or descending order. | |
| filter | No | The Search API filter conditions against the segment fields. | |
| offset | No | The pagination offset. | |
| max | No | The maximum results to be displayed in the response. | |
Response
{
"total": 123, //total number of segments
"segments": [ //array of full SegmentTO objects
{
"id": "S1",
"segmentLabel": "Platinum Members",
"lastEvaluationDate": "2000-10-31T01:30:00.000-05:00"
},
{
"id": "S2",
"segmentLabel": "Small Business owners",
"lastEvaluationDate": "2000-10-31T01:30:00.000-05:00"
}
]
}