Get a contact by email address

Last updated June 17, 2020

GET /contacts/v1/contact/email/:contact_email/profile

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

contacts

The get a contact by email address endpoint allows a given account to get information about a single contact by its email address.

Use case for this endpoint: When integrating an external CRM with HubSpot, you can use this endpoint to correlate contacts by email address.

Example URL:  https://api.hubapi.com/contacts/v1/contact/email/testingapis@hubspot.com/profile?hapikey=demo

Response details

Since all contacts in HubSpot are de-duplicated by email address, requests will always return a single contact.

  • A successful request returns a 200 response with contact information in the body.
  • Returns a 404 response if no contact with the requested email address exists in HubSpot.
Required parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.
Contact email address Used in the request URL The email address for the contact you're searching for.
Optional parameters How to use Description
Property &property=x&property=y - Used in the request URL By default, all valued properties will be included. If you include the "property" parameter, then the returned data will only include the property or properties that you request. You can include this parameter multiple times to specify multiple properties. The lastmodifieddate and associatedcompanyid will always be included, even if not specified. Keep in mind that only properties that have a value will be included in the response, even if specified in the URL.
Property mode &propertyMode=x One of “value_only” or “value_and_history” to specify if the current value for a property should be fetched, or the value and all the historical values for that property. Default is “value_and_history”.
Form submission mode &formSubmissionMode=x One of “all,” “none,” “newest,” “oldest” to specify which form submissions should be fetched. Default is “all.”
List memberships &showListMemberships=x Boolean "true" or "false" to indicate whether current list memberships should be fetched for the contact. Default is true.