Get a group of contact lists

GET /contacts/v1/lists/batch

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

For a given portal, return a set of contact lists that you specify with multiple listId parameters.

This will return only the metadata on these lists and not all of the contacts in the list. See this page for details on getting contact records in individual lists.

See the Contact List Overview for details about the returned data

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.
List IDs &listId=X - Used in the request URL An integer that represents the list IDs that you want returned to your call. As you can see in the example URL below, you can specify as many "listId" parameters as you wish on the URL to return multiple lists at once. Any list IDs that are invalid will be ignored.
Optional Parameters How to use Description
None None No optional parameters for this method.

Example URL is here:  https://api.hubapi.com/contacts/v1/lists/batch?listId=2&listId=3&listId=4&listId=5&hapikey=demo