ghl_email_legacy_campaign_list
Read-onlyIdempotent
List email campaigns from legacy schedules with filters for status, email status, and pagination.
Instructions
Legacy schedule/campaign listing (2021-era, distinct from the v3 campaign family at /emails/locations/{locationId}/campaigns/emails). Supports limit/offset pagination plus status and emailStatus filters. Get Campaigns Endpoint: GET /emails/schedule (Version header: 2021-07-28; source: emails.json) OAuth scopes: emails/schedule.readonly Pagination params: limit, offset — pass them to page through full result sets.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Filter campaigns by name | |
| limit | No | Maximum number of campaigns to return. Defaults to 10, maximum is 100 | |
| offset | No | Number of campaigns to skip for pagination | |
| status | No | Filter by schedule status | active |
| archived | No | Filter archived campaigns | |
| parentId | No | Filter campaigns by parent folder ID | |
| showStats | No | 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. | |
| locationId | Yes | Location ID to fetch campaigns from | |
| emailStatus | No | Filter by email delivery status | complete |
| campaignsOnly | No | Return only campaigns, excluding folders | |
| limitedFields | No | 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 |