Get all the contacts

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 opts = {
  'limit': 50, 
  'offset': 0, 
  'modifiedSince': new Date('2021-09-07T19:20:30+01:00') 
};
apiInstance.getContacts(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\ContactsApi(
    new GuzzleHttp\Client(),
    $config
);
$limit = 50; 
$offset = 0; 
$modifiedSince = new \DateTime('2021-09-07T19:20:30+01:00');

try {
    $result = $apiInstance->getContacts($limit, $offset, $modifiedSince);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->getContacts: ', $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))
limit = 50
offset = 0
modified_since = '2020-09-20T19:20:30+01:00'

try:
    api_response = api_instance.get_contacts(limit=limit, offset=offset, modified_since=modified_since)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsApi->get_contacts: %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 limit= 50;
let offset= 0;
let modifiedSince = new Date('2021-09-07T19:20:30+01:00');
 
apiInstance.getContacts(limit,offset,modifiedSince).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 {
            ContactsApi api = new ContactsApi();
            Long limit = 50l;
            Long offset = 0l;
            String modifiedSince = "2020-01-26T15:10:00+05:30";
            String sort = null;
            GetContacts response = api.getContacts(limit, offset, modifiedSince, 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 ContactsApi();
            long? limit = 10;
            long? offset = 5;
            string modifiedSince = "2020-06-26T11:17:10.970+05:30";
            try
            {
                GetContacts result = apiInstance.GetContacts(limit, offset, modifiedSince);
                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)
	var params = &ContactsApiGetContactsOpts{
    Limit: optional.NewInt64(50),
    Offset: optional.NewInt64(0),
		ModifiedSince: optional.NewString("2020-09-20T19:20:30+01:00"),
	}

	obj, resp, err := sib.ContactsApi.GetContacts(ctx, params)
  if err != nil{
    fmt.println("Error when calling ContactsApi->GetContacts: ",err.Error())
    return
  }
	fmt.Println("GetAllContact Object:",obj," GetAllContact Response: ",resp)
	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

opts = { 
  limit: 50, # Integer | Number of documents per page
  offset: 0, # Integer | Index of the first document of the page
  modified_since: DateTime.iso8601('2021-02-03T04:05:06+07:00'), # String | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
  sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
}

begin
  #Get all the contacts
  result = api_instance.get_contacts(opts)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->get_contacts: #{e}"
end
Language
Credentials
Header
Click Try It! to start a request and see the response here!