There's a new version of the HubSpot API

Check out the new 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 batch of contacts by vid

Last updated May 12, 2023

GET /contacts/v1/contact/vids/batch/

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

For a given account, return information about a group of contacts by their unique IDs. A contact's unique ID is stored in a field called 'vid' which stands for 'visitor ID'.

The endpoint accepts many query parameters that allow for customization based on a variety of integration use cases. By default, this endpoint will not return the history for properties, only the current value of any populated properties, but you can include the history using the parameters listed below.

Requests should be limited to 100 records in a single request.

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(s) &vid=x - Specify each VIDs to fetch Each vid requires it's own query parameter (vid=10&vid=11). Requests should be limited to 100 or fewer vids. Any vids that are provided that are invalid will be ignored.
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. If this parameter is used, only the specified property or properties will be included.
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/vids/batch/?vid=3234574&vid=3714024

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example GET URL: https://api.hubapi.com/contacts/v1/contact/vids/batch/?vid=3234574&vid=3714024&hapikey=demo Example JSON output: { "3234574": { "vid": 3234574, "canonical-vid": 3234574, "merged-vids": [ ], "portal-id": 62515, "is-contact": true, "properties": { "hs_analytics_last_url": { "value": "" }, "lead_source": { "value": "DiscoverOrg" }, "num_unique_conversion_events": { "value": "0" }, "hs_analytics_revenue": { "value": "0.0" }, "createdate": { "value": "1484026585538" }, "hs_analytics_first_referrer": { "value": "" }, "hs_email_optout": { "value": "true" }, "hs_predictivecontactscore": { "value": "50" }, "annualrevenue": { "value": "181900000" }, "hs_analytics_num_page_views": { "value": "0" }, "state": { "value": "MA" }, "zip": { "value": "02139" }, "fortune_rank": { "value": "" }, "hs_predictivecontactscorebucket": { "value": "bucket_3" }, "hubspotscore": { "value": "0" }, "linkedinconnections": { "value": "0" }, "hs_lifecyclestage_subscriber_date": { "value": "1484026585538" }, "hs_analytics_average_page_views": { "value": "0" }, "lastname": { "value": "Test" }, "twitterhandle": { "value": "ghidinelli" }, "phone": { "value": "555-122-2323" }, "num_conversion_events": { "value": "0" }, "currentlyinworkflow": { "value": "false" }, "hs_analytics_num_event_completions": { "value": "2" }, "followercount": { "value": "582" }, "hs_email_optout_2849": { "value": "" }, "associatedcompanyid": { "value": "184896670" }, "firstname": { "value": "HubSpot" }, "city": { "value": "Cambridge" }, "hs_email_optout_354586": { "value": "" }, "hs_social_num_broadcast_clicks": { "value": "0" }, "hs_analytics_last_timestamp": { "value": "" }, "hs_analytics_num_visits": { "value": "0" }, "twitterbio": { "value": "Racer, entrepreneur, world traveler. Crossfitter, foodie, kitesurfing newbie. If racing is life, I'm building a lifestyle business @MotorsportReg @RaceHeroApp" }, "hs_social_linkedin_clicks": { "value": "0" }, "hs_analytics_last_visit_timestamp": { "value": "" }, "hs_social_last_engagement": { "value": "" }, "hs_twitterid": { "value": "49019793" }, "associatedcompanylastupdated": { "value": "13365279006997343" }, "hs_analytics_source": { "value": "OFFLINE" }, "company": { "value": "HubSpot" }, "email": { "value": "testingapis@hubspot.com" }, "linkedinbio": { "value": "Racecar driver, entrepreneur, world traveler" }, "hs_analytics_first_url": { "value": "" }, "website": { "value": "http://hubspot.com" }, "address": { "value": "25 First Street" }, "hs_analytics_first_visit_timestamp": { "value": "" }, "hs_analytics_first_timestamp": { "value": "1484026585538" }, "lastmodifieddate": { "value": "1484859513090" }, "photo": { "value": "https://d2ojpxxtu63wzl.cloudfront.net/static/5b37fd1365186dd697c8a4c950be4222_f4b374414287ef87185ce792c90c266ce333e83eac137c3105bdbd20994556a5" }, "hs_social_google_plus_clicks": { "value": "0" }, "hs_analytics_last_referrer": { "value": "" }, "kloutscoregeneral": { "value": "48" }, "hs_email_optout_230318": { "value": "" }, "hs_social_facebook_clicks": { "value": "0" }, "twitterprofilephoto": { "value": "https://pbs.twimg.com/profile_images/712369625632116736/PNku5AjB_reasonably_small.jpg" }, "hs_analytics_source_data_2": { "value": "" }, "hs_social_twitter_clicks": { "value": "0" }, "hs_analytics_source_data_1": { "value": "API" }, "lifecyclestage": { "value": "subscriber" } }, "form-submissions": [ ], "identity-profiles": [ { "vid": 3234574, "saved-at-timestamp": 1484026585613, "deleted-changed-timestamp": 0, "identities": [ { "type": "EMAIL", "value": "testingapis@hubspot.com", "timestamp": 1484026585538 }, { "type": "LEAD_GUID", "value": "4b11f8af-50d9-4665-9c43-bb2fc46e3a80", "timestamp": 1484026585610 } ] } ], "merge-audits": [ ], "associated-company": { "company-id": 184896670, "portal-id": 62515, "properties": { "country": { "value": "United States" }, "city": { "value": "Cambridge" }, "num_associated_contacts": { "value": "102" }, "timezone": { "value": "America/New_York" }, "facebook_company_page": { "value": "https://www.facebook.com/hubspot" }, "createdate": { "value": "1457708103847" }, "description": { "value": "HubSpot is the world’s leading inbound marketing and sales platform. Since 2006, HubSpot has been on a mission to make the world more inbound. Today, over 10,000 customers in 65 countries use HubSpot’s software, services, and support to transform the way they attract, engage, and delight customers. HubSpot’s inbound marketing software, ranked #1 in customer satisfaction by VentureBeat and G2Crowd, includes social media publishing and monitoring, blogging, SEO, website content management, email marketing, marketing automation, and reporting and analytics, all in one integrated platform. Signals, HubSpot’s award-winning sales application, enables sales and service teams to have more effective conversations with leads, prospects, and customers. HubSpot is headquartered in Cambridge, MA with an office in Dublin, Ireland, and has been recognized by Inc., Forbes, and Deloitte as one of the world’s fastest-growing companies." }, "industry": { "value": "COMPUTER_SOFTWARE" }, "total_money_raised": { "value": "$100.5M" }, "days_to_close": { "value": "220" }, "hs_analytics_num_visits": { "value": "0" }, "linkedin_company_page": { "value": "http://www.linkedin.com/company/68529" }, "recent_conversion_event_name": { "value": "Contact Us: excedalogic form" }, "hs_analytics_source": { "value": "OFFLINE" }, "num_contacted_notes": { "value": "12" }, "annualrevenue": { "value": "250000000" }, "founded_year": { "value": "2006" }, "hs_analytics_num_page_views": { "value": "0" }, "state": { "value": "MA" }, "linkedinbio": { "value": "HubSpot is the world’s leading inbound marketing and sales platform. Since 2006, HubSpot has been on a mission to make the world more inbound. Today, over 10,000 customers in 65 countries use HubSpot’s software, services, and support to transform the way they attract, engage, and delight customers. HubSpot’s inbound marketing software, ranked #1 in customer satisfaction by VentureBeat and G2Crowd, includes social media publishing and monitoring, blogging, SEO, website content management, email marketing, marketing automation, and reporting and analytics, all in one integrated platform. Signals, HubSpot’s award-winning sales application, enables sales and service teams to have more effective conversations with leads, prospects, and customers. HubSpot is headquartered in Cambridge, MA with an office in Dublin, Ireland, and has been recognized by Inc., Forbes, and Deloitte as one of the world’s fastest-growing companies." }, "notes_next_activity_date": { "value": "" }, "zip": { "value": "02141" }, "notes_last_updated": { "value": "1480625888696" }, "website": { "value": "hubspot.com" }, "closedate": { "value": "1476768116137" }, "hs_analytics_first_timestamp": { "value": "1390574181854" }, "first_conversion_date": { "value": "1477892839033" }, "engagements_last_meeting_booked": { "value": "" }, "first_contact_createdate": { "value": "1390574181854" }, "twitterhandle": { "value": "HubSpot" }, "hs_lastmodifieddate": { "value": "1484854497180" }, "notes_last_contacted": { "value": "1479030015191" }, "phone": { "value": "+1 888-482-7768" }, "num_conversion_events": { "value": "40" }, "domain": { "value": "hubspot.com" }, "is_public": { "value": "true" }, "name": { "value": "Hubspot, Inc." }, "recent_conversion_date": { "value": "1484844458500" }, "hs_analytics_source_data_2": { "value": "" }, "hs_analytics_source_data_1": { "value": "" }, "first_conversion_event_name": { "value": "excedalogic form" }, "num_notes": { "value": "12" } } } }, "3714024": { "vid": 3714024, "canonical-vid": 3714024, "merged-vids": [ ], "portal-id": 62515, "is-contact": true, "properties": { "country": { "value": "United States of America" }, "hs_analytics_last_url": { "value": "" }, "num_unique_conversion_events": { "value": "0" }, "hs_analytics_revenue": { "value": "0.0" }, "createdate": { "value": "1484693212904" }, "hs_analytics_first_referrer": { "value": "" }, "hs_email_optout": { "value": "" }, "days_to_close": { "value": "2" }, "hs_predictivecontactscore": { "value": "51" }, "hs_analytics_num_page_views": { "value": "0" }, "hs_predictivecontactscorebucket": { "value": "bucket_3" }, "hubspotscore": { "value": "0" }, "hs_lifecyclestage_subscriber_date": { "value": "1484693212904" }, "hs_analytics_average_page_views": { "value": "0" }, "lastname": { "value": "Record" }, "num_conversion_events": { "value": "0" }, "currentlyinworkflow": { "value": "false" }, "hs_analytics_num_event_completions": { "value": "0" }, "hs_lifecyclestage_customer_date": { "value": "1484854496353" }, "hs_email_optout_2849": { "value": "" }, "associatedcompanyid": { "value": "184896670" }, "firstname": { "value": "Updated" }, "hs_email_optout_354586": { "value": "" }, "hs_social_num_broadcast_clicks": { "value": "0" }, "hs_analytics_last_timestamp": { "value": "" }, "hs_analytics_num_visits": { "value": "0" }, "hs_social_linkedin_clicks": { "value": "0" }, "hs_analytics_last_visit_timestamp": { "value": "" }, "hs_social_last_engagement": { "value": "" }, "associatedcompanylastupdated": { "value": "14538011802288603" }, "hs_analytics_source": { "value": "OFFLINE" }, "business_type": { "value": "Other" }, "email": { "value": "new-email@hubspot.com" }, "hs_analytics_first_url": { "value": "" }, "website": { "value": "http://updated.example.com" }, "address": { "value": "" }, "closedate": { "value": "1484854496353" }, "hs_analytics_first_visit_timestamp": { "value": "" }, "hs_analytics_first_timestamp": { "value": "1484693212904" }, "lastmodifieddate": { "value": "1484854580823" }, "hs_social_google_plus_clicks": { "value": "0" }, "hs_analytics_last_referrer": { "value": "" }, "hs_email_optout_230318": { "value": "" }, "hs_social_facebook_clicks": { "value": "0" }, "hs_analytics_source_data_2": { "value": "" }, "hs_social_twitter_clicks": { "value": "0" }, "hs_analytics_source_data_1": { "value": "API" }, "lifecyclestage": { "value": "customer" }, "hs_email_sends_since_last_engagement": { "value": "0" } }, "form-submissions": [ ], "identity-profiles": [ { "vid": 3714024, "saved-at-timestamp": 1484854496366, "deleted-changed-timestamp": 0, "identities": [ { "type": "LEAD_GUID", "value": "670706c0-3f5c-485b-9bee-5d0b0c6aef97", "timestamp": 1484693212959 }, { "type": "EMAIL", "value": "new-email@hubspot.com", "timestamp": 1484854496353 } ] } ], "merge-audits": [ ], "associated-company": { "company-id": 184896670, "portal-id": 62515, "properties": { "country": { "value": "United States" }, "city": { "value": "Cambridge" }, "num_associated_contacts": { "value": "102" }, "timezone": { "value": "America/New_York" }, "facebook_company_page": { "value": "https://www.facebook.com/hubspot" }, "createdate": { "value": "1457708103847" }, "description": { "value": "HubSpot is the world’s leading inbound marketing and sales platform. Since 2006, HubSpot has been on a mission to make the world more inbound. Today, over 10,000 customers in 65 countries use HubSpot’s software, services, and support to transform the way they attract, engage, and delight customers. HubSpot’s inbound marketing software, ranked #1 in customer satisfaction by VentureBeat and G2Crowd, includes social media publishing and monitoring, blogging, SEO, website content management, email marketing, marketing automation, and reporting and analytics, all in one integrated platform. Signals, HubSpot’s award-winning sales application, enables sales and service teams to have more effective conversations with leads, prospects, and customers. HubSpot is headquartered in Cambridge, MA with an office in Dublin, Ireland, and has been recognized by Inc., Forbes, and Deloitte as one of the world’s fastest-growing companies." }, "industry": { "value": "COMPUTER_SOFTWARE" }, "total_money_raised": { "value": "$100.5M" }, "days_to_close": { "value": "220" }, "hs_analytics_num_visits": { "value": "0" }, "linkedin_company_page": { "value": "http://www.linkedin.com/company/68529" }, "recent_conversion_event_name": { "value": "Contact Us: excedalogic form" }, "hs_analytics_source": { "value": "OFFLINE" }, "num_contacted_notes": { "value": "12" }, "annualrevenue": { "value": "250000000" }, "founded_year": { "value": "2006" }, "hs_analytics_num_page_views": { "value": "0" }, "state": { "value": "MA" }, "linkedinbio": { "value": "HubSpot is the world’s leading inbound marketing and sales platform. Since 2006, HubSpot has been on a mission to make the world more inbound. Today, over 10,000 customers in 65 countries use HubSpot’s software, services, and support to transform the way they attract, engage, and delight customers. HubSpot’s inbound marketing software, ranked #1 in customer satisfaction by VentureBeat and G2Crowd, includes social media publishing and monitoring, blogging, SEO, website content management, email marketing, marketing automation, and reporting and analytics, all in one integrated platform. Signals, HubSpot’s award-winning sales application, enables sales and service teams to have more effective conversations with leads, prospects, and customers. HubSpot is headquartered in Cambridge, MA with an office in Dublin, Ireland, and has been recognized by Inc., Forbes, and Deloitte as one of the world’s fastest-growing companies." }, "notes_next_activity_date": { "value": "" }, "zip": { "value": "02141" }, "notes_last_updated": { "value": "1480625888696" }, "website": { "value": "hubspot.com" }, "closedate": { "value": "1476768116137" }, "hs_analytics_first_timestamp": { "value": "1390574181854" }, "first_conversion_date": { "value": "1477892839033" }, "engagements_last_meeting_booked": { "value": "" }, "first_contact_createdate": { "value": "1390574181854" }, "twitterhandle": { "value": "HubSpot" }, "hs_lastmodifieddate": { "value": "1484854497180" }, "notes_last_contacted": { "value": "1479030015191" }, "phone": { "value": "+1 888-482-7768" }, "num_conversion_events": { "value": "40" }, "domain": { "value": "hubspot.com" }, "is_public": { "value": "true" }, "name": { "value": "Hubspot, Inc." }, "recent_conversion_date": { "value": "1484844458500" }, "hs_analytics_source_data_2": { "value": "" }, "hs_analytics_source_data_1": { "value": "" }, "first_conversion_event_name": { "value": "excedalogic form" }, "num_notes": { "value": "12" } } } } }