List Email Campaigns

GET 
/emails/locations/:locationId/campaigns/emails

Get list of email campaigns for a location

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location ID

limit number

Number of campaigns to return. Defaults to 10, minimum is 1, maximum is 20

Possible values: >= 1 and <= 20

Default value:10

offset number

Number of campaigns to skip for pagination. Defaults to 0, minimum is 0

Possible values: >= 0

Default value:0

search string

Search text for campaign name

status string

Filter by campaign status

Available optionsallsentfailedarchiveddraftprocessingscheduledcancelledpaused

application/json

Success

application/json

Schema

Schema

campaignsobject[]required

List of email campaigns

totalnumberrequired

Total count of email campaigns

traceIdstring

Trace ID of the request

Example (auto)

{
  "campaigns": [
    {
      "id": "67f15c2ae99226d5bcccb8f3",
      "name": "February Newsletter",
      "status": "sent",
      "deleted": false,
      "createdAt": "2025-07-24T11:55:43.598Z",
      "updatedAt": "2026-02-09T04:49:12.322Z"
    }
  ],
  "total": 25,
  "traceId": "019e4ef5-a65e-4198-8cf9-8e93dca9bda4"
}