There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Get all contact lists

Last updated January 7, 2025

GET /contacts/v1/lists

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

crm.lists.read

This endpoint will return all the contact lists for an account.

Use case for this endpoint: It can be used to synchronize list filters between HubSpot and an external system.

Response details

By default, you will get up to 20 lists at a time.  You can get more lists in a single request (up to 250) using the count parameter. Each response will include an offset, which can be used with the offset= parameter in the next request to get the next page of lists.

The listId is the account specific ID for the list. This value never changes for a particular list. The internalListId is an internal identifier used to track the list criteria revisions, and is subject to change when the list is modified.

See the Contact List Overview for details about the returned data. 

Note: The size property returned is an approximate number. This number varies based on the number of contacts in your HubSpot account and is calculated as an estimate.
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 representing the number of lists you want returned to your call. If the parameter isn't included, it defaults to 20. The maximum accepted value is 250; higher values will be accepted, but you will only get 250 records.
Offset &offset=X - Used in the request URL Used to page through the results. Each request will include a "has-more" field in the response JSON, which lets you know if there are more lists that you can pull. If "has-more" is true, you can use the returned offset parameter in the next request to get the next set of results.

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

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example GET URL: https://api.hubapi.com/contacts/v1/lists?count=2 Example response: { "lists": [ { "dynamic": true, "metaData": { "processing": "DONE", "size": 161, "error": "", "lastProcessingStateChangeAt": 1477518645996, "lastSizeChangeAt": 1479298304451 }, "name": "test emails", "filters": [ [ { "filterFamily": "PropertyValue", "withinTimeMode": "PAST", "checkPastVersions": false, "type": "string", "property": "email", "value": "test", "operator": "STR_STARTS_WITH" } ] ], "portalId": 62515, "createdAt": 1335448813688, "listId": 1, "updatedAt": 1477944356444, "listType": "DYNAMIC", "internalListId": 220441, "deleteable": true }, { "dynamic": false, "metaData": { "processing": "DONE", "size": 2, "error": "", "lastProcessingStateChangeAt": 1344891893390, "lastSizeChangeAt": 1478203761479 }, "name": "staticTest", "filters": [ ], "portalId": 62515, "createdAt": 1344891893390, "listId": 3, "updatedAt": 1463648268810, "listType": "STATIC", "internalListId": 5 } ], "offset": 2, "has-more": true }