Subscribers

Manage lists subscribers, fetch single profiles, or search contacts.
GET /subscribers

Retrieves a paginated list of mailing subscribers. Supports searching by keyword and filtering by status or list.

Query Parameters

Parameter Type Status Description
list_uuid String (UUID) Optional Filter subscribers belonging to a specific mailing list UUID.
search String Optional Keyword search. Matches first name, last name, or email.
status String Optional Filter by subscriber status: active, unsubscribed, bounced, complained.
per_page Integer Optional Number of records per page (Default: 15).

cURL Example

curl -X GET "https://api.hotsol.net/api/v1/subscribers?search=john&status=active" \
     -H "Authorization: Bearer hk_sec_your_secret_key_here" \
     -H "Accept: application/json"

Response Example

{
    "success": true,
    "message": "Subscribers retrieved successfully.",
    "data": [
        {
            "id": 12,
            "uuid": "7a3bd0d3-c90a-429a-8b84-ea17b64d1f2e",
            "list_id": 1,
            "email": "john.doe@gmail.com",
            "first_name": "John",
            "last_name": "Doe",
            "status": "active",
            "ip_address": "192.168.1.1",
            "source": "api",
            "open": 2,
            "click": 1,
            "created_at": "2026-08-16T10:30:00.000000Z",
            "updated_at": "2026-08-22T08:15: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
    }
}
GET /subscribers/{uuid}

Retrieves complete profile details and custom field metadata for a single subscriber by their UUID or subscriber ID.

URL Parameters

Parameter Type Status Description
uuid String (UUID or ID) Required The unique UUID or physical numeric ID of the subscriber.

cURL Example

curl -X GET "https://api.hotsol.net/api/v1/subscribers/7a3bd0d3-c90a-429a-8b84-ea17b64d1f2e" \
     -H "Authorization: Bearer hk_sec_your_secret_key_here" \
     -H "Accept: application/json"

Response Example

{
    "success": true,
    "message": "Subscriber details retrieved successfully.",
    "data": {
        "id": 12,
        "uuid": "7a3bd0d3-c90a-429a-8b84-ea17b64d1f2e",
        "list_id": 1,
        "email": "john.doe@gmail.com",
        "first_name": "John",
        "last_name": "Doe",
        "status": "active",
        "ip_address": "192.168.1.1",
        "source": "api",
        "open": 2,
        "click": 1,
        "custom_fields": {
            "c_field_1": "Developer",
            "c_field_2": "Google"
        },
        "created_at": "2026-08-16T10:30:00.000000Z",
        "updated_at": "2026-08-22T08:15:00.000000Z",
        "list": {
            "id": 1,
            "uuid": "4c8f9db0-4fdc-4a3b-9a84-18a72b64d1f2",
            "name": "Weekly Newsletter"
        },
        "profile": {
            "id": 12,
            "subscriber_id": 12,
            "company": "Google LLC",
            "address1": "1600 Amphitheatre Pkwy",
            "city": "Mountain View",
            "state": "CA",
            "zip": "94043",
            "country": "United States",
            "phone": "+1 650-253-0000"
        }
    }
}