GET
/
contacts
/
v1
/
contact
/
vids
/
batch
/
Get a batch of contacts by vid
curl --request GET \
  --url https://api.hubapi.com/contacts/v1/contact/vids/batch/
"\nExample GET URL:\nhttps://api.hubapi.com/contacts/v1/contact/vids/batch/?vid=3234574&vid=3714024&hapikey=demo\n\n\nExample JSON output:\n{\n  \"3234574\": {\n    \"vid\": 3234574,\n    \"canonical-vid\": 3234574,\n    \"merged-vids\": [\n      \n    ],\n    \"portal-id\": 62515,\n    \"is-contact\": true,\n    \"properties\": {\n      \"hs_analytics_last_url\": {\n        \"value\": \"\"\n      },\n      \"lead_source\": {\n        \"value\": \"DiscoverOrg\"\n      },\n      \"num_unique_conversion_events\": {\n        \"value\": \"0\"\n      },\n      \"hs_analytics_revenue\": {\n        \"value\": \"0.0\"\n      },\n      \"createdate\": {\n        \"value\": \"1484026585538\"\n      },\n      \"hs_analytics_first_referrer\": {\n        \"value\": \"\"\n      },\n      \"hs_email_optout\": {\n        \"value\": \"true\"\n      },\n      \"hs_predictivecontactscore\": {\n        \"value\": \"50\"\n      },\n      \"annualrevenue\": {\n        \"value\": \"181900000\"\n      },\n      \"hs_analytics_num_page_views\": {\n        \"value\": \"0\"\n      },\n      \"state\": {\n        \"value\": \"MA\"\n      },\n      \"zip\": {\n        \"value\": \"02139\"\n      },\n      \"fortune_rank\": {\n        \"value\": \"\"\n      },\n      \"hs_predictivecontactscorebucket\": {\n        \"value\": \"bucket_3\"\n      },\n      \"hubspotscore\": {\n        \"value\": \"0\"\n      },\n      \"linkedinconnections\": {\n        \"value\": \"0\"\n      },\n      \"hs_lifecyclestage_subscriber_date\": {\n        \"value\": \"1484026585538\"\n      },\n      \"hs_analytics_average_page_views\": {\n        \"value\": \"0\"\n      },\n      \"lastname\": {\n        \"value\": \"Test\"\n      },\n      \"twitterhandle\": {\n        \"value\": \"ghidinelli\"\n      },\n      \"phone\": {\n        \"value\": \"555-122-2323\"\n      },\n      \"num_conversion_events\": {\n        \"value\": \"0\"\n      },\n      \"currentlyinworkflow\": {\n        \"value\": \"false\"\n      },\n      \"hs_analytics_num_event_completions\": {\n        \"value\": \"2\"\n      },\n      \"followercount\": {\n        \"value\": \"582\"\n      },\n      \"hs_email_optout_2849\": {\n        \"value\": \"\"\n      },\n      \"associatedcompanyid\": {\n        \"value\": \"184896670\"\n      },\n      \"firstname\": {\n        \"value\": \"HubSpot\"\n      },\n      \"city\": {\n        \"value\": \"Cambridge\"\n      },\n      \"hs_email_optout_354586\": {\n        \"value\": \"\"\n      },\n      \"hs_social_num_broadcast_clicks\": {\n        \"value\": \"0\"\n      },\n      \"hs_analytics_last_timestamp\": {\n        \"value\": \"\"\n      },\n      \"hs_analytics_num_visits\": {\n        \"value\": \"0\"\n      },\n      \"twitterbio\": {\n        \"value\": \"Racer, entrepreneur, world traveler. Crossfitter, foodie, kitesurfing newbie. If racing is life, I'm building a lifestyle business @MotorsportReg @RaceHeroApp\"\n      },\n      \"hs_social_linkedin_clicks\": {\n        \"value\": \"0\"\n      },\n      \"hs_analytics_last_visit_timestamp\": {\n        \"value\": \"\"\n      },\n      \"hs_social_last_engagement\": {\n        \"value\": \"\"\n      },\n      \"hs_twitterid\": {\n        \"value\": \"49019793\"\n      },\n      \"associatedcompanylastupdated\": {\n        \"value\": \"13365279006997343\"\n      },\n      \"hs_analytics_source\": {\n        \"value\": \"OFFLINE\"\n      },\n      \"company\": {\n        \"value\": \"HubSpot\"\n      },\n      \"email\": {\n        \"value\": \"testingapis@hubspot.com\"\n      },\n      \"linkedinbio\": {\n        \"value\": \"Racecar driver, entrepreneur, world traveler\"\n      },\n      \"hs_analytics_first_url\": {\n        \"value\": \"\"\n      },\n      \"website\": {\n        \"value\": \"http://hubspot.com\"\n      },\n      \"address\": {\n        \"value\": \"25 First Street\"\n      },\n      \"hs_analytics_first_visit_timestamp\": {\n        \"value\": \"\"\n      },\n      \"hs_analytics_first_timestamp\": {\n        \"value\": \"1484026585538\"\n      },\n      \"lastmodifieddate\": {\n        \"value\": \"1484859513090\"\n      },\n      \"photo\": {\n        \"value\": \"https://d2ojpxxtu63wzl.cloudfront.net/static/5b37fd1365186dd697c8a4c950be4222_f4b374414287ef87185ce792c90c266ce333e83eac137c3105bdbd20994556a5\"\n      },\n      \"hs_social_google_plus_clicks\": {\n        \"value\": \"0\"\n      },\n      \"hs_analytics_last_referrer\": {\n        \"value\": \"\"\n      },\n      \"kloutscoregeneral\": {\n        \"value\": \"48\"\n      },\n      \"hs_email_optout_230318\": {\n        \"value\": \"\"\n      },\n      \"hs_social_facebook_clicks\": {\n        \"value\": \"0\"\n      },\n      \"twitterprofilephoto\": {\n        \"value\": \"https://pbs.twimg.com/profile_images/712369625632116736/PNku5AjB_reasonably_small.jpg\"\n      },\n      \"hs_analytics_source_data_2\": {\n        \"value\": \"\"\n      },\n      \"hs_social_twitter_clicks\": {\n        \"value\": \"0\"\n      },\n      \"hs_analytics_source_data_1\": {\n        \"value\": \"API\"\n      },\n      \"lifecyclestage\": {\n        \"value\": \"subscriber\"\n      }\n    },\n    \"form-submissions\": [\n      \n    ],\n    \"identity-profiles\": [\n      {\n        \"vid\": 3234574,\n        \"saved-at-timestamp\": 1484026585613,\n        \"deleted-changed-timestamp\": 0,\n        \"identities\": [\n          {\n            \"type\": \"EMAIL\",\n            \"value\": \"testingapis@hubspot.com\",\n            \"timestamp\": 1484026585538\n          },\n          {\n            \"type\": \"LEAD_GUID\",\n            \"value\": \"4b11f8af-50d9-4665-9c43-bb2fc46e3a80\",\n            \"timestamp\": 1484026585610\n          }\n        ]\n      }\n    ],\n    \"merge-audits\": [\n      \n    ],\n    \"associated-company\": {\n      \"company-id\": 184896670,\n      \"portal-id\": 62515,\n      \"properties\": {\n        \"country\": {\n          \"value\": \"United States\"\n        },\n        \"city\": {\n          \"value\": \"Cambridge\"\n        },\n        \"num_associated_contacts\": {\n          \"value\": \"102\"\n        },\n        \"timezone\": {\n          \"value\": \"America/New_York\"\n        },\n        \"facebook_company_page\": {\n          \"value\": \"https://www.facebook.com/hubspot\"\n        },\n        \"createdate\": {\n          \"value\": \"1457708103847\"\n        },\n        \"description\": {\n          \"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.\"\n        },\n        \"industry\": {\n          \"value\": \"COMPUTER_SOFTWARE\"\n        },\n        \"total_money_raised\": {\n          \"value\": \"$100.5M\"\n        },\n        \"days_to_close\": {\n          \"value\": \"220\"\n        },\n        \"hs_analytics_num_visits\": {\n          \"value\": \"0\"\n        },\n        \"linkedin_company_page\": {\n          \"value\": \"http://www.linkedin.com/company/68529\"\n        },\n        \"recent_conversion_event_name\": {\n          \"value\": \"Contact Us: excedalogic form\"\n        },\n        \"hs_analytics_source\": {\n          \"value\": \"OFFLINE\"\n        },\n        \"num_contacted_notes\": {\n          \"value\": \"12\"\n        },\n        \"annualrevenue\": {\n          \"value\": \"250000000\"\n        },\n        \"founded_year\": {\n          \"value\": \"2006\"\n        },\n        \"hs_analytics_num_page_views\": {\n          \"value\": \"0\"\n        },\n        \"state\": {\n          \"value\": \"MA\"\n        },\n        \"linkedinbio\": {\n          \"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.\"\n        },\n        \"notes_next_activity_date\": {\n          \"value\": \"\"\n        },\n        \"zip\": {\n          \"value\": \"02141\"\n        },\n        \"notes_last_updated\": {\n          \"value\": \"1480625888696\"\n        },\n        \"website\": {\n          \"value\": \"hubspot.com\"\n        },\n        \"closedate\": {\n          \"value\": \"1476768116137\"\n        },\n        \"hs_analytics_first_timestamp\": {\n          \"value\": \"1390574181854\"\n        },\n        \"first_conversion_date\": {\n          \"value\": \"1477892839033\"\n        },\n        \"engagements_last_meeting_booked\": {\n          \"value\": \"\"\n        },\n        \"first_contact_createdate\": {\n          \"value\": \"1390574181854\"\n        },\n        \"twitterhandle\": {\n          \"value\": \"HubSpot\"\n        },\n        \"hs_lastmodifieddate\": {\n          \"value\": \"1484854497180\"\n        },\n        \"notes_last_contacted\": {\n          \"value\": \"1479030015191\"\n        },\n        \"phone\": {\n          \"value\": \"+1 888-482-7768\"\n        },\n        \"num_conversion_events\": {\n          \"value\": \"40\"\n        },\n        \"domain\": {\n          \"value\": \"hubspot.com\"\n        },\n        \"is_public\": {\n          \"value\": \"true\"\n        },\n        \"name\": {\n          \"value\": \"Hubspot, Inc.\"\n        },\n        \"recent_conversion_date\": {\n          \"value\": \"1484844458500\"\n        },\n        \"hs_analytics_source_data_2\": {\n          \"value\": \"\"\n        },\n        \"hs_analytics_source_data_1\": {\n          \"value\": \"\"\n        },\n        \"first_conversion_event_name\": {\n          \"value\": \"excedalogic form\"\n        },\n        \"num_notes\": {\n          \"value\": \"12\"\n        }\n      }\n    }\n  },\n  \"3714024\": {\n    \"vid\": 3714024,\n    \"canonical-vid\": 3714024,\n    \"merged-vids\": [\n      \n    ],\n    \"portal-id\": 62515,\n    \"is-contact\": true,\n    \"properties\": {\n      \"country\": {\n        \"value\": \"United States of America\"\n      },\n      \"hs_analytics_last_url\": {\n        \"value\": \"\"\n      },\n      \"num_unique_conversion_events\": {\n        \"value\": \"0\"\n      },\n      \"hs_analytics_revenue\": {\n        \"value\": \"0.0\"\n      },\n      \"createdate\": {\n        \"value\": \"1484693212904\"\n      },\n      \"hs_analytics_first_referrer\": {\n        \"value\": \"\"\n      },\n      \"hs_email_optout\": {\n        \"value\": \"\"\n      },\n      \"days_to_close\": {\n        \"value\": \"2\"\n      },\n      \"hs_predictivecontactscore\": {\n        \"value\": \"51\"\n      },\n      \"hs_analytics_num_page_views\": {\n        \"value\": \"0\"\n      },\n      \"hs_predictivecontactscorebucket\": {\n        \"value\": \"bucket_3\"\n      },\n      \"hubspotscore\": {\n        \"value\": \"0\"\n      },\n      \"hs_lifecyclestage_subscriber_date\": {\n        \"value\": \"1484693212904\"\n      },\n      \"hs_analytics_average_page_views\": {\n        \"value\": \"0\"\n      },\n      \"lastname\": {\n        \"value\": \"Record\"\n      },\n      \"num_conversion_events\": {\n        \"value\": \"0\"\n      },\n      \"currentlyinworkflow\": {\n        \"value\": \"false\"\n      },\n      \"hs_analytics_num_event_completions\": {\n        \"value\": \"0\"\n      },\n      \"hs_lifecyclestage_customer_date\": {\n        \"value\": \"1484854496353\"\n      },\n      \"hs_email_optout_2849\": {\n        \"value\": \"\"\n      },\n      \"associatedcompanyid\": {\n        \"value\": \"184896670\"\n      },\n      \"firstname\": {\n        \"value\": \"Updated\"\n      },\n      \"hs_email_optout_354586\": {\n        \"value\": \"\"\n      },\n      \"hs_social_num_broadcast_clicks\": {\n        \"value\": \"0\"\n      },\n      \"hs_analytics_last_timestamp\": {\n        \"value\": \"\"\n      },\n      \"hs_analytics_num_visits\": {\n        \"value\": \"0\"\n      },\n      \"hs_social_linkedin_clicks\": {\n        \"value\": \"0\"\n      },\n      \"hs_analytics_last_visit_timestamp\": {\n        \"value\": \"\"\n      },\n      \"hs_social_last_engagement\": {\n        \"value\": \"\"\n      },\n      \"associatedcompanylastupdated\": {\n        \"value\": \"14538011802288603\"\n      },\n      \"hs_analytics_source\": {\n        \"value\": \"OFFLINE\"\n      },\n      \"business_type\": {\n        \"value\": \"Other\"\n      },\n      \"email\": {\n        \"value\": \"new-email@hubspot.com\"\n      },\n      \"hs_analytics_first_url\": {\n        \"value\": \"\"\n      },\n      \"website\": {\n        \"value\": \"http://updated.example.com\"\n      },\n      \"address\": {\n        \"value\": \"\"\n      },\n      \"closedate\": {\n        \"value\": \"1484854496353\"\n      },\n      \"hs_analytics_first_visit_timestamp\": {\n        \"value\": \"\"\n      },\n      \"hs_analytics_first_timestamp\": {\n        \"value\": \"1484693212904\"\n      },\n      \"lastmodifieddate\": {\n        \"value\": \"1484854580823\"\n      },\n      \"hs_social_google_plus_clicks\": {\n        \"value\": \"0\"\n      },\n      \"hs_analytics_last_referrer\": {\n        \"value\": \"\"\n      },\n      \"hs_email_optout_230318\": {\n        \"value\": \"\"\n      },\n      \"hs_social_facebook_clicks\": {\n        \"value\": \"0\"\n      },\n      \"hs_analytics_source_data_2\": {\n        \"value\": \"\"\n      },\n      \"hs_social_twitter_clicks\": {\n        \"value\": \"0\"\n      },\n      \"hs_analytics_source_data_1\": {\n        \"value\": \"API\"\n      },\n      \"lifecyclestage\": {\n        \"value\": \"customer\"\n      },\n      \"hs_email_sends_since_last_engagement\": {\n        \"value\": \"0\"\n      }\n    },\n    \"form-submissions\": [\n      \n    ],\n    \"identity-profiles\": [\n      {\n        \"vid\": 3714024,\n        \"saved-at-timestamp\": 1484854496366,\n        \"deleted-changed-timestamp\": 0,\n        \"identities\": [\n          {\n            \"type\": \"LEAD_GUID\",\n            \"value\": \"670706c0-3f5c-485b-9bee-5d0b0c6aef97\",\n            \"timestamp\": 1484693212959\n          },\n          {\n            \"type\": \"EMAIL\",\n            \"value\": \"new-email@hubspot.com\",\n            \"timestamp\": 1484854496353\n          }\n        ]\n      }\n    ],\n    \"merge-audits\": [\n      \n    ],\n    \"associated-company\": {\n      \"company-id\": 184896670,\n      \"portal-id\": 62515,\n      \"properties\": {\n        \"country\": {\n          \"value\": \"United States\"\n        },\n        \"city\": {\n          \"value\": \"Cambridge\"\n        },\n        \"num_associated_contacts\": {\n          \"value\": \"102\"\n        },\n        \"timezone\": {\n          \"value\": \"America/New_York\"\n        },\n        \"facebook_company_page\": {\n          \"value\": \"https://www.facebook.com/hubspot\"\n        },\n        \"createdate\": {\n          \"value\": \"1457708103847\"\n        },\n        \"description\": {\n          \"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.\"\n        },\n        \"industry\": {\n          \"value\": \"COMPUTER_SOFTWARE\"\n        },\n        \"total_money_raised\": {\n          \"value\": \"$100.5M\"\n        },\n        \"days_to_close\": {\n          \"value\": \"220\"\n        },\n        \"hs_analytics_num_visits\": {\n          \"value\": \"0\"\n        },\n        \"linkedin_company_page\": {\n          \"value\": \"http://www.linkedin.com/company/68529\"\n        },\n        \"recent_conversion_event_name\": {\n          \"value\": \"Contact Us: excedalogic form\"\n        },\n        \"hs_analytics_source\": {\n          \"value\": \"OFFLINE\"\n        },\n        \"num_contacted_notes\": {\n          \"value\": \"12\"\n        },\n        \"annualrevenue\": {\n          \"value\": \"250000000\"\n        },\n        \"founded_year\": {\n          \"value\": \"2006\"\n        },\n        \"hs_analytics_num_page_views\": {\n          \"value\": \"0\"\n        },\n        \"state\": {\n          \"value\": \"MA\"\n        },\n        \"linkedinbio\": {\n          \"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.\"\n        },\n        \"notes_next_activity_date\": {\n          \"value\": \"\"\n        },\n        \"zip\": {\n          \"value\": \"02141\"\n        },\n        \"notes_last_updated\": {\n          \"value\": \"1480625888696\"\n        },\n        \"website\": {\n          \"value\": \"hubspot.com\"\n        },\n        \"closedate\": {\n          \"value\": \"1476768116137\"\n        },\n        \"hs_analytics_first_timestamp\": {\n          \"value\": \"1390574181854\"\n        },\n        \"first_conversion_date\": {\n          \"value\": \"1477892839033\"\n        },\n        \"engagements_last_meeting_booked\": {\n          \"value\": \"\"\n        },\n        \"first_contact_createdate\": {\n          \"value\": \"1390574181854\"\n        },\n        \"twitterhandle\": {\n          \"value\": \"HubSpot\"\n        },\n        \"hs_lastmodifieddate\": {\n          \"value\": \"1484854497180\"\n        },\n        \"notes_last_contacted\": {\n          \"value\": \"1479030015191\"\n        },\n        \"phone\": {\n          \"value\": \"+1 888-482-7768\"\n        },\n        \"num_conversion_events\": {\n          \"value\": \"40\"\n        },\n        \"domain\": {\n          \"value\": \"hubspot.com\"\n        },\n        \"is_public\": {\n          \"value\": \"true\"\n        },\n        \"name\": {\n          \"value\": \"Hubspot, Inc.\"\n        },\n        \"recent_conversion_date\": {\n          \"value\": \"1484844458500\"\n        },\n        \"hs_analytics_source_data_2\": {\n          \"value\": \"\"\n        },\n        \"hs_analytics_source_data_1\": {\n          \"value\": \"\"\n        },\n        \"first_conversion_event_name\": {\n          \"value\": \"excedalogic form\"\n        },\n        \"num_notes\": {\n          \"value\": \"12\"\n        }\n      }\n    }\n  }\n}"

Path Parameters

contact_email
string
required

The email address for the contact you're searching for.

Query Parameters

property
string

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.

propertyMode
string

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.

formSubmissionMode
string

One of all, none, newest, oldest to specify which form submissions should be fetched. Default is all.

showListMemberships
string

Boolean true or false to indicate whether current list memberships should be fetched for the contact. Default is true.

Response

200 - application/json

Successful response - The get a contact by email address endpoint allows a given account to get information about a single contact by its email address

The response is of type object.