Get a contact's details

There are 2 ways to get a contact

Option 1- https://api.brevo.com/v3/contacts/{identifier}

Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={}

Option 1 only works if identifierType is email_id (for EMAIL), phone_id (for SMS) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL, SMS and ID of the contact.

Option 2 works for all identifierType, use email_id for EMAIL attribute, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute

Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats https://developers.brevo.com/reference/contacts-7#getcontactstats endpoint with the appropriate date ranges.

Log in to see full request history

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 identifier = "example@example.com"; apiInstance.getContactInfo(identifier).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 = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR API KEY'); $apiInstance = new Brevo\Client\Api\ContactsApi( new GuzzleHttp\Client(), $config ); $identifier = 'example@example.com'; try { $result = $apiInstance->getContactInfo($identifier); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->getContactInfo: ', $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)) email = 'example@example.com' try: api_response = api_instance.get_contact_info(email) pprint(api_response) except ApiException as e: print("Exception when calling ContactsApi->get_contact_info: %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 identifier = "example@example.com"; apiInstance.getContactInfo(identifier).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.*; 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(); String email = "example@example.com"; GetExtendedContactDetails response = api.getContactInfo(email); 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(); string email = "example@example.com"; try { GetExtendedContactDetails result = apiInstance.GetContactInfo(email); 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) identifier := "example@example.com" //string|email identifier exRes,resp, err := sib.ContactsApi.GetContactInfo(ctx, identifier) if err!=nil{ fmt.Println("Error in ContactsApi->GetContactInfo ",err.Error()) return } fmt.Println( "GetContactInfo extended data: ",exRes,"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 identifier = 'example@example.com' # String | Email (urlencoded) OR ID of the contact OR its SMS attribute value begin #Get a contact's details result = api_instance.get_contact_info(identifier) p result rescue SibApiV3Sdk::ApiError => e puts "Exception when calling ContactsApi->get_contact_info: #{e}" end
Path Params
required

Email (urlencoded) OR ID of the contact OR its SMS attribute value OR EXT_ID attribute (urlencoded)

Query Params
string

email_id for Email, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute

string

Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate

string

Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate.

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json