Search for a contact by email address

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

For a given portal, return information about a single contact by its email address.

Since all contacts in HubSpot are de-duplicated off of an email address, you will only ever receive a single contact back from the API.

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 that you're searching for.
Optional Parameters How to use Description
Property &property=X - 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.
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.

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

Returns a 200 response with the data for the contact in the body of the response on success.

Returns a 404 response if there is no contact with that email address.