Skip to main content
GET
/
emails
/
campaigns
/
bulk-actions
Get Bulk Action Campaigns
curl --request GET \
  --url https://services.leadconnectorhq.com/emails/campaigns/bulk-actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Version: <version>'
{
  "campaigns": [
    {
      "id": "OI72xYec4Mho6VBykTvj",
      "name": "Test Mail",
      "status": "complete",
      "scheduleType": "NOW",
      "createdBy": "John Doe",
      "deleted": false,
      "createdAt": "2025-07-24T11:55:43.598Z",
      "updatedAt": "2026-02-09T04:49:12.322Z",
      "completedAt": "2025-07-24T11:55:48.000Z",
      "emailMetadata": {
        "subject": "Welcome to our platform",
        "from": "John Doe <john@example.com>",
        "name": "John Doe",
        "templateId": "6790aeb53c8d1288f555f92b"
      }
    }
  ],
  "total": 25
}

Authorizations

Authorization
string
header
required

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Headers

Version
enum<string>
required

API Version

Available options:
2021-07-28
Example:

"2021-07-28"

Query Parameters

locationId
string
required

Location ID

Example:

"ve9EPM428h8vShlRW1KT"

limit
number
default:10

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

Required range: 1 <= x <= 20
Example:

10

offset
number
default:0

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

Required range: x >= 0
Example:

0

dateFrom
string

Filter by start date (ISO 8601 format)

Example:

"2024-01-01T00:00:00.000Z"

dateTo
string

Filter by end date (ISO 8601 format)

Example:

"2024-12-31T23:59:59.999Z"

status
enum<string>

Filter by status

Available options:
processing,
scheduled,
paused,
complete,
cancelled
Example:

"complete"

Response

Success

campaigns
object[]
required

List of bulk action campaigns

total
number
required

Total count of bulk action campaigns

Example:

25

Last modified on March 4, 2026