Read one campaign

GEThttps://app.softsolz.uk/api/v1/services/outreach/campaigns/{id}

Recent Requests

Kept only in this browser

TimeStatusTook

Send a request with Try it to see it here.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Response

Response Body

campaignobjectThe campaign.

Request

curl --request GET \
  --url https://app.softsolz.uk/api/v1/services/outreach/campaigns/{id} \
  --header 'Authorization: Bearer sk_live_your_key'

Credentials

Authorization

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
  "data": {
    "campaign": {
      "id": "128",
      "tenant_id": "4c1a7e52-9b3d-4f86-a2e1-7d5c0b9f3e61",
      "name": "Autumn offer",
      "channel": "sms",
      "provider": "twilio",
      "template_name": "autumn_offer",
      "template_language": "en",
      "template_variables": {
        "1": "Jane"
      },
      "body_preview": "Hi {{name}}, 20% off this week.",
      "media_filename": "offer.jpg",
      "media_mime": "image/jpeg",
      "has_media": false,
      "audience": {
        "book_ids": [
          "42"
        ],
        "include_contacts": false
      },
      "status": "draft",
      "scheduled_at": "2026-10-05T09:00:00.000Z",
      "total_count": 120,
      "sent_count": 80,
      "delivered_count": 76,
      "read_count": 41,
      "failed_count": 2,
      "skipped_count": 3,
      "consecutive_failures": 0,
      "pause_reason": null,
      "pause_detail": null,
      "resume_after": null,
      "created_by": 4115,
      "created_at": "2026-09-01T09:00:00.000Z",
      "updated_at": "2026-09-01T09:00:00.000Z",
      "started_at": null,
      "completed_at": null,
      "subject": "Your autumn offer",
      "subject_b": null,
      "ab_split_percent": null,
      "ab_winner": null,
      "body_html": "<p>Hello {{name}}</p>",
      "from_sender_id": "7",
      "template_key": null,
      "source_campaign_id": null,
      "source_engagement": null,
      "track_links": true,
      "local_time": false,
      "fallback_sms_body": null,
      "ai_agent_id": null,
      "ai_settings": {},
      "visibility": "tenant",
      "shared_users": [
        {
          "user_id": 4115,
          "name": "Jane Doe",
          "email": "jane@example.com"
        }
      ],
      "shared_roles": [
        {
          "role_id": 12,
          "role_name": "manager"
        }
      ],
      "uploaded_count": 0
    }
  }
}