Get campaign details

Get a single campaign with its sender, subject, template reference, targeting and delivery progress.

Get campaign details

get

Get a single campaign with its sender, subject, template reference, targeting and delivery progress.

This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.

Authorizations

AuthorizationstringRequired

API Token authentication

Path parameters

profileUuidstringRequired

Profile uuid parameter

Example: 550e8400-e09b-41d4-a716-400055000000

campaignUuidstringRequired

Campaign uuid parameter

Example: 550e8400-e09b-41d4-a716-400055000000

Responses

200

Success response

application/json

uuidstringOptionalExample: 550e8400-e29b-41d4-a716-446655440000

titlestringOptionalExample: Black Friday Campaign

subjectstringOptionalExample: Don't miss our Black Friday deals!

sender_namestringOptionalExample: Marketing Team

sender_emailstringOptionalExample: [e-mail]

template_uuidstring · nullableOptional

The email template this campaign uses. The template title is not exposed.

Example: 2080cc86-e026-4f7b-9598-d4132f8c7c2f

statusstring · enumOptional

A fully sent campaign is publish. There is no sent, paused or archived status.

Example: publishPossible values:

typestring · enumOptionalExample: campaignPossible values:

failure_reasonstring · nullableOptional

Set only while the status is failed.

Example: sending_limit_reached

is_smart_sendbooleanOptional

Whether delivery time is picked per contact rather than sent to everyone at once.

Example: false

is_all_contactsbooleanOptional

Whether the campaign targets every contact instead of the listed segments.

Example: false

segment_uuidsstring[]Optional

Segments this campaign targets. Empty when it targets all contacts.

Example: 2080cc86-e026-4f7b-9598-d4132f8c7c2f

created_atstring · date-timeOptionalExample: 2025-02-27T11:54:22Z

updated_atstring · date-time · nullableOptionalExample: 2025-03-04T09:12:07Z

sent_atstring · date-time · nullableOptionalExample: 2025-03-04T09:12:07Z

scheduled_atstring · date-time · nullableOptionalExample: 2025-03-04T08:00:00Z

401

Unauthenticated response

application/json

500

Error response

application/json

get/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}

GET /api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid} HTTP/1.1
Host: developers.hostinger.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "title": "Black Friday Campaign",
  "subject": "Don't miss our Black Friday deals!",
  "sender_name": "Marketing Team",
  "sender_email": "[e-mail]",
  "template_uuid": "2080cc86-e026-4f7b-9598-d4132f8c7c2f",
  "status": "publish",
  "type": "campaign",
  "failure_reason": "sending_limit_reached",
  "is_smart_send": false,
  "is_all_contacts": false,
  "delivery": {
    "total_sent": 100,
    "estimated_total_recipients": 900,
    "subscribers_count": 900
  },
  "segment_uuids": [
    "2080cc86-e026-4f7b-9598-d4132f8c7c2f"
  ],
  "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"
}