For the complete documentation index, see llms.txt. This page is also available as Markdown.

List profile segments

Get a paginated list of the segments defined in a profile.

List profile segments

get

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.

Authorizations
AuthorizationstringRequired

API Token authentication

Path parameters
profileUuidstringRequired

Profile uuid parameter

Example: 550e8400-e09b-41d4-a716-400055000000
Query parameters
count_typestring · enumOptional

Which matching contacts to count for each segment

Default: allExample: allPossible values:
pageintegerOptional

Page number

Example: 1
per_pageinteger · max: 100Optional

Number of items per page

Default: 25Example: 25
Responses
200

Success response

application/json
get/api/reach/v1/profiles/{profileUuid}/segmentation/segments
GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments HTTP/1.1
Host: developers.hostinger.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "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
  }
}

Last updated

Was this helpful?