Get One Campaign

Retrieve full details of a specific campaign using its unique campaign identifier.

📨 Get One Campaign

Use this endpoint to fetch data of a single campaign by UID.


🔹 HTTP Request

GET API-URL/campaigns/CAMPAIGN-UNIQUE-ID

🔸 URL Segments

Segment
Required
Description

CAMPAIGN-UNIQUE-ID

Yes

Campaign unique ID to retrieve.


🔐 Authorization Header

X-API-KEY: your-api-key-here

💻 PHP Example

// GET ONE ITEM
$response = $endpoint->getCampaign('CAMPAIGN-UNIQUE-ID');

// DISPLAY RESPONSE
echo '<pre>';
print_r($response->body);
echo '</pre>';

📦 Sample JSON Response

{
  "status": "success",
  "data": {
    "record": {
      "campaign_uid": "ab781xqmvk274",
      "campaign_id": "201",
      "name": "Demo API Campaign #1",
      "type": "regular",
      "from_name": "Alice Walker",
      "from_email": "[email protected]",
      "to_name": "[EMAIL]",
      "reply_to": "[email protected]",
      "subject": "🚀 Testing Campaigns via API Integration",
      "status": "sent",
      "date_added": "2025-04-16T14:55:00",
      "send_at": "2025-04-16T14:57:00",
      "list": {
        "list_uid": "xy5934demo938",
        "name": "Demo List 2025",
        "subscribers_count": 0
      },
      "segment": [],
      "group": []
    }
  }
}

Last updated