--- title: "Return all your created email campaigns" method: GET path: "/emailCampaigns" tags: ["Email Campaigns"] --- # Return all your created email campaigns `GET /emailCampaigns` ## Query parameters - `type` 'classic' | 'trigger' - `status` 'suspended' | 'archive' | 'sent' | 'queued' | 'draft' | 'inProcess' - `statistics` 'globalStats' | 'linksStats' | 'statsByDomain' - `startDate` string - `endDate` string - `limit` integer - `offset` integer - `sort` 'asc' | 'desc' - `excludeHtmlContent` boolean ## Response `200` Email campaigns informations - GetEmailCampaigns - `campaigns` object[] - `id` integer, required — ID of the campaign - `name` string, required — Name of the campaign - `subject` string — Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` - `previewText` string — Preview text or preheader of the email campaign - `type` 'classic' | 'trigger', required — Type of campaign - `status` 'draft' | 'sent' | 'archive' | 'queued' | 'suspended' | 'in_process', required — Status of the campaign - `scheduledAt` string — UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) - `abTesting` boolean — Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. - `subjectA` string — Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` - `subjectB` string — Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` - `splitRule` integer — The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` - `winnerCriteria` string — Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` - `winnerDelay` integer — The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` - `sendAtBestTime` boolean — It is true if you have chosen to send your campaign at best time, otherwise it is false - `utmCampaignValue` string — utm parameter associated with campaign - `utmSource` string — source of utm parameter - `utmMedium` string — medium parameter - `utmID` integer — utm id - `testSent` boolean, required — Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) - `header` string, required — Header of the campaign - `footer` string, required — Footer of the campaign - `sender` GetExtendedCampaignOverviewSender, required - `name` string — Sender name of the campaign - `email` string, email — Sender email of the campaign - `id` integer — Sender id of the campaign - `replyTo` string, email, required — Email defined as the "Reply to" of the campaign - `toField` string — Customisation of the "to" field of the campaign - `htmlContent` string, required — HTML content of the campaign - `shareLink` string, url — Link to share the campaign on social medias - `tag` string — Tag of the campaign - `createdAt` string, required — Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) - `modifiedAt` string, required — UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) - `inlineImageActivation` boolean — Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. - `mirrorActive` boolean — Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign - `recurring` boolean — FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times - `sentDate` string — Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' - `returnBounce` integer — Total number of non-delivered campaigns for a particular campaign id. - `recipients` GetCampaignRecipients, required - `lists` integer[], required - `exclusionLists` integer[], required - `statistics` GetExtendedCampaignStats, required - `globalStats` GetCampaignStats, required - `listId` integer — List Id of email campaign (only in case of get email campaign(s)(not for global stats)) - `uniqueClicks` integer, required — Number of unique clicks for the campaign - `clickers` integer, required — Number of total clicks for the campaign - `complaints` integer, required — Number of complaints (Spam reports) for the campaign - `delivered` integer, required — Number of delivered emails for the campaign - `sent` integer, required — Number of sent emails for the campaign - `softBounces` integer, required — Number of softbounce for the campaign - `hardBounces` integer, required — Number of harbounce for the campaign - `uniqueViews` integer, required — Number of unique openings for the campaign - `trackableViews` integer, required — Recipients without any privacy protection option enabled in their email client - `trackableViewsRate` number, float — Rate of recipients without any privacy protection option enabled in their email client - `estimatedViews` integer — Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails - `unsubscriptions` integer, required — Number of unsubscription for the campaign - `viewed` integer, required — Number of openings for the campaign - `deferred` integer — Number of deferred emails for the campaign - `returnBounce` integer — Total number of non-delivered campaigns for a particular campaign id. - `campaignStats` GetCampaignStats[], required — List-wise statistics of the campaign. - `listId` integer — List Id of email campaign (only in case of get email campaign(s)(not for global stats)) - `uniqueClicks` integer, required — Number of unique clicks for the campaign - `clickers` integer, required — Number of total clicks for the campaign - `complaints` integer, required — Number of complaints (Spam reports) for the campaign - `delivered` integer, required — Number of delivered emails for the campaign - `sent` integer, required — Number of sent emails for the campaign - `softBounces` integer, required — Number of softbounce for the campaign - `hardBounces` integer, required — Number of harbounce for the campaign - `uniqueViews` integer, required — Number of unique openings for the campaign - `trackableViews` integer, required — Recipients without any privacy protection option enabled in their email client - `trackableViewsRate` number, float — Rate of recipients without any privacy protection option enabled in their email client - `estimatedViews` integer — Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails - `unsubscriptions` integer, required — Number of unsubscription for the campaign - `viewed` integer, required — Number of openings for the campaign - `deferred` integer — Number of deferred emails for the campaign - `returnBounce` integer — Total number of non-delivered campaigns for a particular campaign id. - `mirrorClick` integer, required — Number of clicks on mirror link - `remaining` integer, required — Number of remaning emails to send - `linksStats` object, required — Statistics about the number of clicks for the links - `statsByDomain` GetStatsByDomain, required - `statsByDevice` GetStatsByDevice, required - `desktop` object — Statistics of the campaign on the basis of desktop devices - `mobile` object — Statistics of the campaign on the basis of mobile devices - `tablet` object — Statistics of the campaign on the basis of tablet devices - `unknown` object — Statistics of the campaign on the basis of unknown devices - `statsByBrowser` GetStatsByBrowser, required - `count` integer — Number of Email campaigns retrieved ## Other responses - `400` — bad request --- [API](https://skmtc.net/getbrevo/apis/brevo-api.md) · [All operations](https://skmtc.net/getbrevo/apis/brevo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getbrevo/brevo-api/versions/2aec3cf66501/schema)