Export contacts

post https://api.brevo.com/v3/contacts/export

It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.

Some contact filter examples are given below-

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

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.ContactsApi();

let requestContactExport = new SibApiV3Sdk.RequestContactExport();

requestContactExport.exportAttributes = ["email"];
requestContactExport.customContactFilter = {"actionForContacts":"allContacts", "listId":2};
requestContactExport.notifyUrl = "https://[email protected]"

apiInstance.requestContactExport(requestContactExport).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\ContactsApi(
    new GuzzleHttp\Client(),
    $config
);
$requestContactExport = new \SendinBlue\Client\Model\RequestContactExport();
$requestContactExport['exportAttributes'] = ['email'];
$requestContactExport['customContactFilter'] = array('actionForContacts'=>'allContacts', 'listId'=>2);
$requestContactExport['notifyUrl'] = 'https://[email protected]';

try {
    $result = $apiInstance->requestContactExport($requestContactExport);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->requestContactExport: ', $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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
request_contact_export = sib_api_v3_sdk.RequestContactExport()
request_contact_export.export_attributes = ["email"]
request_contact_export.custom_contact_filter = {"actionForContacts":"allContacts", "listId":2}
request_contact_export.notify_url = "https://[email protected]"

try:
    api_response = api_instance.request_contact_export(request_contact_export)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsApi->request_contact_export: %s\n" % e)

const SibApiV3Sdk = require('sib-api-v3-typescript');
 
let apiInstance = new SibApiV3Sdk.ContactsApi()

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

let requestContactExport = new SibApiV3Sdk.RequestContactExport(); 

requestContactExport.exportAttributes = ["email"];
requestContactExport.customContactFilter = {"actionForContacts":"allContacts", "listId":2};
requestContactExport.notifyUrl = "https://[email protected]"

apiInstance.requestContactExport(requestContactExport).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 java.util.*;
import java.util.List;

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 {
            ContactsApi api = new ContactsApi();
            List<String> exportAttributes = new ArrayList<String>();
            exportAttributes.add("EMAIL");
            RequestContactExportCustomContactFilter requestContactExportCustomContactFilter = new RequestContactExportCustomContactFilter();
            requestContactExportCustomContactFilter.setActionForContacts(RequestContactExportCustomContactFilter.ActionForContactsEnum.ALLCONTACTS);
            requestContactExportCustomContactFilter.setListId(2l);
            RequestContactExport requestContactExport = new RequestContactExport();
            requestContactExport.setExportAttributes(exportAttributes);
            requestContactExport.setNotifyUrl("https://[email protected]");
            requestContactExport.setCustomContactFilter(requestContactExportCustomContactFilter);
            CreatedProcessId response = api.requestContactExport(requestContactExport);
            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;
using Newtonsoft.Json.Linq;
using System.Collections.Generic;

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

            var apiInstance = new ContactsApi();
            List<string> exportAttributes = new List<string>();
            exportAttributes.Add("EMAIL");
            JObject contactFilter = null;
            RequestContactExportCustomContactFilter customContactFilter = new RequestContactExportCustomContactFilter();
            customContactFilter.ActionForContacts = RequestContactExportCustomContactFilter.ActionForContactsEnum.AllContacts;
            customContactFilter.ListId = 2;
            string notifyUrl = "https://[email protected]";
            try
            {
                var requestContactExport = new RequestContactExport(exportAttributes, contactFilter, customContactFilter, notifyUrl);
                CreatedProcessId result = apiInstance.RequestContactExport(requestContactExport);
                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"
)

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)
	body := RequestContactExport{
		ExportAttributes: []string{"email"},
		CustomContactFilter: &RequestContactExportCustomContactFilter{
			ActionForContacts: "allContacts",
			ListId:            int64(2),
		},
		NotifyUrl: "https://[email protected]",
	}
	id, resp, err := sib.ContactsApi.RequestContactExport(ctx, body)
    if err!=nil{
        fmt.Println("Error in ContactsApi->RequestContactExport ",err.Error())
        return
    }
	fmt.Println( "RequestContactExport response:",resp,"RequestContactExport processId:",id)
	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::ContactsApi.new

request_contact_export = SibApiV3Sdk::RequestContactExport.new # RequestContactExport | Values to request a contact export

request_contact_export = {
  'exportAttributes' => ['email'];
  'customContactFilter' => {'actionForContacts'=>'allContacts', 'listId'=>2};
  'notifyUrl' => 'https://[email protected]'
}

begin
  #Export contacts
  result = api_instance.request_contact_export(request_contact_export)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->request_contact_export: #{e}"
end