Reach: Segments
List profile segments
Get a paginated list of the segments defined in a profile.
Each entry carries the number of contacts currently matching it, which is recalculated on read rather than stored. Use count_type to count either every matching contact or only the subscribed ones.
get/api/reach/v1/profiles/{profileUuid}/segmentation/segments
Path parameters
profileUuidstring required
Example:550e8400-e09b-41d4-a716-400055000000
Profile uuid parameter
Query parameters
count_type'all' | 'subscribed'
Example:all
Which matching contacts to count for each segment
pageinteger
Example:1
Page number
per_pageinteger
Example:25
Number of items per page
Response
Success response
Example response
{
"data": [
{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"name": "VIP Customers",
"contacts_count": 150,
"created_at": "2025-02-27T11:54:22Z",
"updated_at": "2025-02-27T11:54:22Z"
}
],
"meta": {
"current_page": 1,
"per_page": 15,
"total": 100
}
}