The v5 API is deprecatedThe v5 API is deprecated and will be sunset on June 30, 2027. Please follow the migration guide to move to the latest stable Omnisend API version.
Intro
Endpoint: https://api.omnisend.com/v5/campaigns
Retrieve a list of campaigns (newsletters, SMS messages, and push notifications) sent or scheduled in your Omnisend account. This read-only API provides campaign metadata and status for reporting and monitoring purposes.
Campaign status
| Status | Description |
|---|---|
| draft | Campaign is being created, not yet finalized |
| pending | Campaign is scheduled but not yet started |
| started | Campaign is actively sending |
| sent | Campaign has finished sending |
| paused | Campaign sending has been paused |
| error | Campaign encountered an error |
Campaign type
| Type | Description |
|---|---|
| standart | Standard campaign sent to all recipients at once |
| abTest | A/B test campaign with multiple variants |
Note: The value "standart" is the actual API value (with the specific spelling).
Campaign channel
| Channel | Description |
|---|---|
| Email campaign | |
| sms | SMS campaign |
| push | Push notification |
Timezone optimization (TZO)
When tzoEnabled is true, the campaign uses timezone optimization to send messages at the optimal time for each recipient based on their timezone.
Date fields with TZO:
startDate/endDate: The configured send window for the campaignsendStartDate/sendEndDate: The actual send window, which may be adjusted by TZO to span multiple timezones
Note: If TZO is enabled,
sendStartDateandsendEndDatereflect the extended delivery window needed to reach all recipients at the same local time.