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 static contact lists

Last updated May 15, 2023

GET /contacts/v1/lists/static

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

crm.lists.read

Get static contact lists in a portal.

Static lists (as opposed to dynamic lists) are lists that are edited (added to or updated) manually - via the add contact to list method, or manually in HubSpot.

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.
Optional Parameters How to use Description
List Count &count=X - Used in the request URL An integer that represents the number of lists that you want returned to your call. Defaults to 20, with a max value of 250. Values higher than 250 will be treated as 250 instead of throwing an error.
List Offset &offset=X - Used in the request URL An integer that represents where to start your list pull from. For instance, if you want to return numbered lists: 50-60, your offset should be "50" and your count parameter (seen above) should be 10. You should also note that the returned JSON (seen below) includes a "has-more" field, which lets you know if there are more lists that you can pull. If "has-more" is true, you can use this offset parameter to pull lists that weren't in your initial call.

Example URL is here:  https://api.hubapi.com/contacts/v1/lists/static?count=1&offset=0