v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB

Contacts

Get a contact's details

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}

Path parameters

identifierstring required

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

Query parameters

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

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.

Response

Contact informations

emailstring email

Email address of the contact for which you requested the details

idinteger required

ID of the contact for which you requested the details

emailBlacklistedboolean required

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

smsBlacklistedboolean required

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

createdAtstring required

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

modifiedAtstring required

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

listIdsinteger[] required

listUnsubscribedinteger[]

attributesobject required

Set of attributes of the contact

Example response

{
  "email": "john.smith@example.com",
  "id": 32,
  "smsBlacklisted": true,
  "createdAt": "2017-05-12T12:30:00Z",
  "modifiedAt": "2017-05-12T12:30:00Z",
  "attributes": {
    "name": "Joe",
    "email": "joe@example.com"
  },
  "statistics": {
    "messagesSent": [
      {
        "campaignId": 3,
        "eventTime": "2017-03-12T20:15:13Z"
      }
    ],
    "hardBounces": [
      {
        "campaignId": 3,
        "eventTime": "2017-03-12T20:15:13Z"
      }
    ],
    "softBounces": [
      {
        "campaignId": 3,
        "eventTime": "2017-03-12T20:15:13Z"
      }
    ],
    "complaints": [
      {
        "campaignId": 3,
        "eventTime": "2017-03-12T20:15:13Z"
      }
    ],
    "unsubscriptions": {
      "userUnsubscription": [
        {
          "campaignId": 3,
          "eventTime": "2017-03-12T20:15:13Z",
          "ip": "165.87.3.15"
        }
      ],
      "adminUnsubscription": [
        {
          "eventTime": "2017-03-12T20:15:13Z",
          "ip": "165.87.3.15"
        }
      ]
    },
    "opened": [
      {
        "campaignId": 3,
        "count": 1,
        "eventTime": "2017-03-12T20:15:13Z",
        "ip": "165.87.3.15"
      }
    ],
    "clicked": [
      {
        "campaignId": 3,
        "links": [
          {
            "count": 1,
            "eventTime": "2017-03-12T20:15:13Z",
            "ip": "165.87.3.15",
            "url": "www.myshop.com"
          }
        ]
      }
    ],
    "delivered": [
      {
        "campaignId": 3,
        "eventTime": "2017-03-12T20:15:13.000+0000"
      }
    ]
  }
}