Get a batch of contacts by their user tokens

GET /contacts/v1/contact/utks/batch/:contact_utk

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 group of contacts by their user tokens, stored in the hubspotutk cookie. This cookie is generated 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(s) &utk=X - Specify each contact to fetch The usertoken that you're looking up. This parameter can be included multiple times to get multiple contacts. Any usertoken that doesn't belong to an existing contact will be ignored. You should include 100 or fewer usertokens in the request.
Optional Parameters How to use Description
Property &property=x Specify the properties that should be returned for each ID. By default, the endpoint returns all valued properties for a contact.
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_only”.
Form Submission Mode &formSubmissionMode=x One of “all”, “none”, “newest”, “oldest” to specify which form submissions should be fetched. Default is “newest”.
List Memberships &showListMemberships=x Boolean "true" or "false" to indicate whether current list memberships should be fetched for the contact. Default is false.
Include Deleted Contacts &includeDeletes=x Boolean "true" or "false" to indicate whether the return of deleted contacts is desired. Default is false.

Example URL:  https://api.hubapi.com/contacts/v1/contact/utks/batch/?utk=f844d2217850188692f2610c717c2e9b&utk=j94344d22178501692f2610c717c2e9b&hapikey=demo