List Segments

Retrieve matching filter segments created inside lists.

GET /segments

Retrieves a paginated list of subscriber filter segments defined within your email lists.

Query Parameters

Parameter	Type	Status	Description
list_uuid	String (UUID)	Optional	Filter segments by a specific mailing list UUID.
per_page	Integer	Optional	Number of records to return per page (Default: `15`).
page	Integer	Optional	The page number of results to fetch (Default: `1`).

cURL Example

curl -X GET "https://api.hotsol.net/api/v1/segments?list_uuid=4c8f9db0-4fdc-4a3b-9a84-18a72b64d1f2" \
     -H "Authorization: Bearer hk_sec_your_secret_key_here" \
     -H "Accept: application/json"

Response Example

{
    "success": true,
    "message": "Segments retrieved successfully.",
    "data": [
        {
            "id": 5,
            "uuid": "8af12cd3-5abc-41e8-a1c2-34f78d90e9d1",
            "list_id": 1,
            "name": "US Subscribers only",
            "operator_match": "all",
            "status": "active",
            "created_at": "2026-08-16T10:00:00.000000Z",
            "updated_at": "2026-08-20T12:00:00.000000Z",
            "list": {
                "id": 1,
                "uuid": "4c8f9db0-4fdc-4a3b-9a84-18a72b64d1f2",
                "name": "Weekly Newsletter"
            }
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 15,
        "total": 1
    }
}