Get a contact's details

GET

https://api.brevo.com/v3/contacts/:identifier

GET

/v3/contacts/:identifier

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.contacts.getContactInfo({
        identifier: "string",
    });
}
main();

{
  "attributes": {
    "ADDRESS": "987 5th avenue",
    "AREA": "NY",
    "CITY": "New-York",
    "CIV": "1",
    "DOB": "1986-04-13",
    "FIRST_NAME": "Peggy",
    "LAST_NAME": "Rain",
    "SMS": "3087433387669",
    "ZIP_CODE": "87544"
  },
  "createdAt": "2017-05-02T16:40:31Z",
  "emailBlacklisted": false,
  "id": 42,
  "listIds": [
    40
  ],
  "modifiedAt": "2017-05-02T16:40:31Z",
  "smsBlacklisted": false,
  "whatsappBlacklisted": false,
  "statistics": {
    "clicked": [
      {
        "campaignId": 21,
        "links": [
          {
            "count": 2,
            "eventTime": "2016-05-03T21:25:01Z",
            "ip": "66.249.93.118",
            "url": "https://url.domain.com/fbe5387ec717e333628380454f68670010b205ff/1/go?uid={EMAIL}&utm_source=brevo&utm_campaign=test_camp&utm_medium=email"
          }
        ]
      }
    ],
    "delivered": [
      {
        "campaignId": 21,
        "eventTime": "2016-05-03T21:24:56Z",
        "count": 2,
        "ip": "66.249.93.118"
      }
    ],
    "messagesSent": [
      {
        "campaignId": 21,
        "eventTime": "2016-05-03T20:15:13Z"
      },
      {
        "campaignId": 42,
        "eventTime": "2016-10-17T10:30:01Z"
      }
    ],
    "opened": [
      {
        "campaignId": 21,
        "count": 2,
        "eventTime": "2016-05-03T21:24:56Z",
        "ip": "66.249.93.118"
      },
      {
        "campaignId": 68,
        "count": 1,
        "eventTime": "2017-01-30T13:56:40Z",
        "ip": "66.249.93.217"
      }
    ]
  },
  "email": "peggy.rain@example.com"
}

Follow this format when passing a “SMS” phone number as an attribute. Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx

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.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

Path parameters

identifierstring or integerRequired

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

Query parameters

identifierTypeenumOptional

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

startDatestringOptional

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.

endDatestringOptional

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

attributesobject

Set of attributes of the contact

createdAtstring

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

emailBlacklistedboolean

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

idlong

ID of the contact for which you requested the details

listIdslist of longs

modifiedAtstring

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

smsBlacklistedboolean

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

whatsappBlacklistedboolean

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

statisticsobject

Campaign statistics of the contact

emailstringOptionalformat: "email"

Email address of the contact for which you requested the details

listUnsubscribedlist of longsOptional

consentGroupslist of objectsOptional

Consent groups the contact belongs to, with their subscription status. Only present when the Consent Groups feature is enabled for your account.

Errors

400

Bad Request Error

404

Not Found Error