Return all your created email campaigns

Code Examples

You can use as reference the code below to implement this call in your preferred language.
Check all our official API clients here

📘
The response payload for this endpoint has changed
You now need to specify which type of statistics you would like to retrieve. For more information visit this page.

const SibApiV3Sdk = require('sib-api-v3-sdk');
let defaultClient = SibApiV3Sdk.ApiClient.instance;

let apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';

let apiInstance = new SibApiV3Sdk.EmailCampaignsApi();

let opts = { 
  'type': "classic",
  'status': "sent", 
  'startDate': new Date("2021-01-01T00:00:00+00:00"),
  'endDate': new Date("2021-01-01T00:00:00+00:00"), 
  'limit': 500,
  'offset': 0
};
apiInstance.getEmailCampaigns(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + JSON.stringify(data));
}, function(error) {
  console.error(error);
});

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR API KEY');

$apiInstance = new SendinBlue\Client\Api\EmailCampaignsApi(
    new GuzzleHttp\Client(),
    $config
);
$type = 'classic';
$status = 'sent';
$startDate = new \DateTime('2021-01-01T00:00:00+00:00');
$endDate = new \DateTime('2021-01-01T00:00:00+00:00');
$limit = 500;
$offset = 0;

try {
    $result = $apiInstance->getEmailCampaigns($type, $status, $startDate, $endDate, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailCampaignsApi->getEmailCampaigns: ', $e->getMessage(), PHP_EOL;
}
?>

from __future__ import print_function
import time
import sib_api_v3_sdk
from sib_api_v3_sdk.rest import ApiException
from pprint import pprint

configuration = sib_api_v3_sdk.Configuration()
configuration.api_key['api-key'] = 'YOUR API KEY'

api_instance = sib_api_v3_sdk.EmailCampaignsApi(sib_api_v3_sdk.ApiClient(configuration))
type = 'classic'
status = 'sent'
start_date = '2020-06-20T19:20:30+01:00'
end_date = '2020-07-20T19:20:30+01:00'
limit = 500
offset = 0

try:
    api_response = api_instance.get_email_campaigns(type=type, status=status, start_date=start_date, end_date=end_date, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailCampaignsApi->get_email_campaigns: %s\n" % e)

const SibApiV3Sdk = require('sib-api-v3-typescript');

let apiInstance = new SibApiV3Sdk.EmailCampaignsApi();

let apiKey = apiInstance.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';

let type = "classic"; 
let status = "sent";
let startDate = new Date("2021-01-01T00:00:00+00:00");
let endDate = new Date("2021-01-01T00:00:00+00:00"); 
let limit = 500;
let offset = 0;

apiInstance.getEmailCampaigns(type, status, startDate, endDate, limit, offset).then(function(data) {
  console.log('API called successfully. Returned data: ' + JSON.stringify(data));
}, function(error) {
  console.error(error);
});

package sibApi;

import sendinblue.ApiClient;
import sendinblue.Configuration;
import sendinblue.auth.ApiKeyAuth;
import sibModel.*;
import org.threeten.bp.OffsetDateTime;

public class Program {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure API key authorization: api-key
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
        apiKey.setApiKey("YOUR API KEY");

        try {
            EmailCampaignsApi api = new EmailCampaignsApi();
            String type = "classic";
            String status = "sent";
            String startDate = "2020-08-22T09:43:51.970+05:30";
            String endDate = "2020-12-31T09:43:51.970+05:30";
            Long limit = 50l;
            Long offset = 0l;
            String sort = "asc";
            GetEmailCampaigns response = api.getEmailCampaigns(type, status, startDate, endDate, limit, offset, sort);
            System.out.println(response.toString());
        } catch (Exception e) {
            System.out.println("Exception occurred:- " + e.getMessage());
        }
    }
}

using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;
using System;
using System.Diagnostics;

namespace Sendinblue
{
    class Program
    {
        static void Main(string[] args)
        {
            Configuration.Default.ApiKey.Add("api-key", "YOUR API KEY");

            var apiInstance = new EmailCampaignsApi();
            string type = "classic"; 
            string status = "sent";
            string startDate = "2020-08-22T09:43:51.970+05:30";
            string endDate = "2020-12-24T16:03:51.000+05:30";
            long? limit = 50;
            long? offset = 0; 
            try
            {
                GetEmailCampaigns result = apiInstance.GetEmailCampaigns(type, status, startDate, endDate, limit, offset);
                Debug.WriteLine(result.ToJson());
                Console.WriteLine(result.ToJson());
                Console.ReadLine();
            }
            catch (Exception e)
            {
                Debug.WriteLine(e.Message);
                Console.WriteLine(e.Message);
                Console.ReadLine();
            }
        }
    }
}

package main
import (
    "fmt"
    "context"
   sib_api_v3_sdk "./lib"
  "github.com/antihax/optional"
)

func main() {
    var ctx context.Context
    var cli = sib_api_v3_sdk.APIClient{
        cfg: sib_api_v3_sdk.NewConfiguration(),
    }
    //Configure API key authorization: api-key
    cli.cfg.AddDefaultHeader("api-key", "YOUR_API_KEY")

    sib := sib_api_v3_sdk.NewAPIClient(cli.cfg)
    params := &EmailCampaignsApiGetEmailCampaignsOpts{
    Type_: optional.NewString("classic"),
    Status:optional.NewString("sent"),
        Limit: optional.NewInt64(500),
    Offset: optional.NewInt64(0),
        StartDate: optional.NewString("2020-06-20T19:20:30+01:00"),
        EndDate: optional.NewString("2020-07-20T19:20:30+01:00"),
    }
    obj, resp, err := sib.EmailCampaignsApi.GetEmailCampaigns(ctx, params)
    if err!=nil{
        fmt.Println("Error in EmailCampaignsApi->GetEmailCampaigns ",err.Error())
        return
    }
    fmt.Println( "GetEmailCampaigns response:",resp," GetEmailCampaigns object:",obj)
    return 
}

# load the gem
require 'sib-api-v3-sdk'
# setup authorization
SibApiV3Sdk.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
end

api_instance = SibApiV3Sdk::EmailCampaignsApi.new

opts = { 
  type: 'classic',
  status: 'sent',
  start_date: DateTime.iso8601('2021-02-03T04:05:06+07:00'),
  end_date: DateTime.iso8601('2021-03-03T04:05:06+07:00'),
  limit: 500,
  offset: 0
}

begin
  #Return all your created email campaigns
  result = api_instance.get_email_campaigns(opts)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling EmailCampaignsApi->get_email_campaigns: #{e}"
end

Code Examples

📘The response payload for this endpoint has changed

📘
The response payload for this endpoint has changed