Get a batch of contacts by vid

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

Method Details

HTTP Methods:


Response Format:


Requires Authentication?


Rate Limited?





Marketing & CRM

For a given portal, return information about a group of contacts by their unique ID's. A contact's unique ID's 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 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 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: