Get Campaigns

GEThttps://services.leadconnectorhq.com/emails/schedule
Get Campaigns
Request

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

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123
Query Parameters
archived
boolean

Filter archived campaigns

Examples:
false
campaignsOnly
boolean

Return only campaigns, excluding folders

Examples:
false
emailStatus
string

Filter by email delivery status

Allowed values:
allnot-startedpausedcancelledprocessingresumednext-dripcompletesuccesserrorwaitingqueuedqueueingreadingscheduled
Default:
complete
limit
number

Maximum number of campaigns to return. Defaults to 10, maximum is 100

Examples:
7
limitedFields
boolean

When true, returns only essential campaign fields like id, templateDataDownloadUrl, updatedAt, type, templateType, templateId, downloadUrl and isPlainText. When false, returns complete campaign data including meta information, bulkRequestStatusInfo, ABTestInfo, resendScheduleInfo and all other campaign properties

Examples:
false
name
string

Filter campaigns by name

Examples:
Black Friday Campaign
offset
number

Number of campaigns to skip for pagination

Examples:
0
parentId
string

Filter campaigns by parent folder ID

Examples:
folder123
showStats
boolean

When true, returns campaign statistics including delivered count, opened count, clicked count and revenue if available for the campaign. When false, returns campaign data without statistics.

Examples:
true
status
string

Filter by schedule status

Allowed values:
activepausecompletecancelledretrydraftresend-scheduled
Default:
active
locationId
string
required

Location ID to fetch campaigns from

Examples:
ohjiah0wdg3bzmzacvd6
Headers
Authorization
string
required

Access Token

Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
required

API Version

Allowed value:
2021-07-28

Responses

Successful response

Body

schedules
array[object]
required

The list of campaigns

name
string
required
Example:
Untitled new campaign
repeatAfter
string
required
id
string
required
parentId
string
required
childCount
number
required
campaignType
string
required
bulkActionVersion
string
required
_id
string
required
status
string
required
sendDays
array[string]
required
deleted
boolean
required
migrated
boolean
required
archived
boolean
required
hasTracking
boolean
required
isPlainText
boolean
required
hasUtmTracking
boolean
required
enableResendToUnopened
boolean
required
locationId
string
required
templateId
string
required
templateType
string
required
createdAt
string
required
updatedAt
string
required
__v
number
required
documentId
string
required
downloadUrl
string
required
templateDataDownloadUrl
string
required
child
array[string]
required
total
array[string]
required

The total number of campaigns

traceId
string
required

Trace Id

Unprocessable Entity

Body

statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity

Unauthorized

Body

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized

Bad Request

Body

statusCode
number
Example:
400
message
string
Example:
Bad Request