Reminder: As of August 9th, the demo API key will only be allowed to make GET requests. Please see the announcement for more details.

Get a contact by its user token

Last updated March 19, 2019

GET /contacts/v1/contact/utk/:contact_utk/profile

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

contacts

For a given account, return information about a single contact by its user token, stored in the hubspotutk cookie. This cookie is created automatically by the HubSpot tracking code.

This method will also return you much of the HubSpot lead "intelligence" for each requested contact record. The endpoint accepts many query parameters that allow for customization based on a variety of integration use cases.

The endpoint does not allow for CORS, so if you are looking up contacts from their user token on the client, you'll need to spin up a proxy server to interact with 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 User Token Used in the request URL The user token (HubSpot cookie) 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:  http://api.hubapi.com/contacts/v1/contact/utk/f844d2217850188692f2610c717c2e9b/profile?hapikey=demo

Returns a 404 response if there is no contact matching that usertoken.