GET

List Campaigns


Returns a list of email campaigns.

By default sorts by the dateUpdated field in the DESC order.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Email Marketing
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/email-marketing/v1/campaigns

Query Params
paging.limitintegerminimum 0format int32

Number of items to load.


paging.offsetintegerminimum 0format int32

Number of items to skip in the current sort order.


optionIncludeStatisticsboolean

Whether to include publishingData.statistics in the returned campaign object.

Default: false.


statusesArray <string>

Campaign status.


visibilityStatusesArray <string>

Visibility status.

Response Object
pagingPaging

Paging parameters.


campaignsArray <Campaign>

List of campaigns.

List Campaigns
Request
cURL
curl -X GET 'https://www.wixapis.com/email-marketing/v1/campaigns?option_include_statistics=true&visibility_statuses=DRAFT&statuses=ACTIVE' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "campaigns": [ { "campaignId": "688565b5-d890-4984-8167-1987c1999a1a", "title": "Yoga with puppies", "firstImageUrl": "https:////static.wixstatic.com/media/eceb8e_baccf99d697447468400ca1aba4c4a60~mv2.jpg", "editorType": "WEB", "status": "ACTIVE", "visibilityStatus": "DRAFT", "distributionStatus": "NOT_STARTED", "dateCreated": "2020-04-23T11:29:22Z", "dateUpdated": "2020-05-14T10:08:33.291462479Z" } ] }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?