contacts

Get a contact's details

<Note>Follow this format when passing a "SMS" phone number as an attribute. Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note> There are 2 ways to get a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={} <br> <br> 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. <br><br> 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 <br><br>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.

get/contacts/{identifier}

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/contacts/{identifier}
  • Auth: API key in header api-key

Path parameters

string required
OR
integer required

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

Query parameters

identifierType'email_id' | 'phone_id' | 'contact_id' | 'ext_id' | 'whatsapp_id' | 'landline_number_id'

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

startDatestring

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

endDatestring

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

Response

Contact informations

attributesContactsIdentifierGetResponsesContentApplicationJsonSchemaAttributes required

Set of attributes of the contact

createdAtstring required

Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ)

emailstring email

Email address of the contact for which you requested the details

emailBlacklistedboolean required

Blacklist status for email campaigns (true=blacklisted, false=not blacklisted)

idinteger required

ID of the contact for which you requested the details

listIdsinteger[] required
listUnsubscribedinteger[]
modifiedAtstring required

Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ)

smsBlacklistedboolean required

Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted)

whatsappBlacklistedboolean required

Blacklist status for WhatsApp campaigns (true=blacklisted, false=not blacklisted)

Changes

No recorded changes to this operation across all 1 revision of this API.