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 list by its unique ID

Last updated May 15, 2023

GET /contacts/v1/lists/:list_id

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

crm.lists.read

For a given portal, return a contact list by its unique ID. This returns only the metadata for the list; see this page for getting the contact records in the list.

If you are not storing the list ids inside of your application, you'll need to first find the list id by using the get all lists endpoint.

See the Contact List Overview for details about the returned data

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.
List ID Used in the request URL Unique identifier for the list that you're looking for.
Optional Parameters How to use Description
None None No optional parameters for this method.

Example URL is here - note that the list ID is "1":  https://api.hubapi.com/contacts/v1/lists/1

Returns a 404 if there is no list with the specified ID.