There's a new version of the HubSpot API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Get a contact by vid

Last updated May 12, 2023

GET /contacts/v1/contact/vid/:vid/profile

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

crm.objects.contacts.read

The get a contact by vid endpoint returns information about a single contact by its ID (vid) for a given account. The contact's unique ID is stored in a field called 'vid,' which stands for 'visitor ID.'

Use case for this endpoint: An integration could use this endpoint to get all updates made to a HubSpot contact since its creation.

Response details

  • Returns a 404 is there is no contact with that vid.
Required parameters How to use Description
OAuth access token or private app access token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.
Contact ID Used in the request URL (see above) Unique identifier for a particular contact. In HubSpot's contact system, contact ID's are called "vid", as you can see in the API output below.
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.

Example URL:  https://api.hubapi.com/contacts/v1/contact/vid/3234574/profile