GET https://services.leadconnectorhq.com/emails/schedule
Authorization
Name
Type
Required
Example
Description
Authorization
string
Yes
Bearer token generated from the Leadway portal. See Authentication.
Version
string
Yes
2021-07-28
API version.
Query parameters
Name
Type
Required
Example
Description
locationId
string
Yes
ohjiah0wdg3bzmzacvd6
Account ID to fetch campaigns from
limit
number
No
7
Maximum number of campaigns to return. Defaults to 10, maximum is 100
offset
number
No
0
Number of campaigns to skip for pagination
status
string
No
Filter by schedule status
emailStatus
string
No
Filter by email delivery status
name
string
No
Black Friday Campaign
Filter campaigns by name
parentId
string
No
folder123
Filter campaigns by parent folder ID
limitedFields
boolean
No
false
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
archived
boolean
No
false
Filter archived campaigns
campaignsOnly
boolean
No
false
Return only campaigns, excluding folders
showStats
boolean
No
true
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.
Responses
200 - Success
schedules (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 (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 (string[], required)
total (string[], required): The total number of campaigns