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

List campaigns

Get a paginated list of the campaigns in a profile.

List campaigns

get

Get a paginated list of the campaigns in a profile.

Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status publish. By default only regular campaigns are returned - pass type to get the emails sent by automations or the double opt-in confirmations instead.

Authorizations
AuthorizationstringRequired

API Token authentication

Path parameters
profileUuidstringRequired

Profile uuid parameter

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

Filter campaigns by status.

A fully sent campaign has the status publish. There is no sent status, and campaigns can be neither paused nor archived.

Example: publishPossible values:
typestring · enumOptional

Filter campaigns by type.

Defaults to campaign, which leaves out the emails sent by automations and the double opt-in confirmations.

Default: campaignExample: campaignPossible values:
sort_directionstring · enumOptional

Order campaigns by creation date. Newest first unless set to asc.

Example: descPossible 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}/campaigns
GET /api/reach/v1/profiles/{profileUuid}/campaigns HTTP/1.1
Host: developers.hostinger.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "data": [
    {
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "title": "Black Friday Campaign",
      "subject": "Don't miss our Black Friday deals!",
      "sender_name": "Marketing Team",
      "sender_email": "marketing@example.com",
      "template_uuid": "2080cc86-e026-4f7b-9598-d4132f8c7c2f",
      "status": "publish",
      "type": "campaign",
      "created_at": "2025-02-27T11:54:22Z",
      "updated_at": "2025-03-04T09:12:07Z",
      "sent_at": "2025-03-04T09:12:07Z",
      "scheduled_at": "2025-03-04T08:00:00Z",
      "statistics": {
        "total_sent": 100,
        "open_rate": 42.5,
        "click_rate": 10,
        "click_to_open_rate": 23.5
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 100
  }
}

Last updated

Was this helpful?