Campaigns

Retrieve details of regular or AutoResponder campaigns created inside your account.
GET /campaigns

Retrieves a paginated list of all campaigns. Supports filtering by campaign type and status.

Query Parameters

Parameter Type Status Description
campaign_type String Optional Filter by type: regular or autoresponder.
status String Optional Filter by send status: draft, sending, sent, paused.
per_page Integer Optional Number of records per page (Default: 15).

cURL Example

curl -X GET "https://api.hotsol.net/api/v1/campaigns?campaign_type=regular&status=sent" \
     -H "Authorization: Bearer hk_sec_your_secret_key_here" \
     -H "Accept: application/json"

Response Example

{
    "success": true,
    "message": "Campaigns retrieved successfully.",
    "data": [
        {
            "id": 8,
            "uuid": "9c8a7b6f-4a3b-4c2d-9e1f-88b77a66c5d4",
            "campaign_type": "regular",
            "campaign_name": "Summer Promotion 2026",
            "subject": "Get 20% off all plans this summer!",
            "from_name": "Hotsol Sales",
            "from_email": "sales@hotsol.io",
            "reply_to": "support@hotsol.io",
            "status": "sent",
            "send_at": "2026-08-21T09:00:00.000000Z",
            "started_at": "2026-08-21T09:00:05.000000Z",
            "finished_at": "2026-08-21T09:12:30.000000Z",
            "sents": 1500,
            "bounces": 12,
            "opens": 450,
            "clicks": 180,
            "unsubscribes": 5,
            "created_at": "2026-08-20T12:00:00.000000Z",
            "updated_at": "2026-08-21T09:12:30.000000Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 15,
        "total": 1
    }
}
GET /campaigns/{uuid}

Retrieves detailed configuration and metrics context for a specific campaign by its UUID or ID.

URL Parameters

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

cURL Example

curl -X GET "https://api.hotsol.net/api/v1/campaigns/9c8a7b6f-4a3b-4c2d-9e1f-88b77a66c5d4" \
     -H "Authorization: Bearer hk_sec_your_secret_key_here" \
     -H "Accept: application/json"

Response Example

{
    "success": true,
    "message": "Campaign details retrieved successfully.",
    "data": {
        "id": 8,
        "uuid": "9c8a7b6f-4a3b-4c2d-9e1f-88b77a66c5d4",
        "campaign_type": "regular",
        "campaign_name": "Summer Promotion 2026",
        "subject": "Get 20% off all plans this summer!",
        "from_name": "Hotsol Sales",
        "from_email": "sales@hotsol.io",
        "reply_to": "support@hotsol.io",
        "message": "<p>Summer sales is on! ...</p>",
        "status": "sent",
        "send_at": "2026-08-21T09:00:00.000000Z",
        "started_at": "2026-08-21T09:00:05.000000Z",
        "finished_at": "2026-08-21T09:12:30.000000Z",
        "sents": 1500,
        "bounces": 12,
        "opens": 450,
        "clicks": 180,
        "unsubscribes": 5,
        "created_at": "2026-08-20T12:00:00.000000Z",
        "updated_at": "2026-08-21T09:12:30.000000Z"
    }
}