Get a contact list by its unique ID

Last updated March 3, 2022

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 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 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?hapikey=demo

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

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/1?hapikey=demo Example response: { "parentId": 0, "metaData": { "processing": "DONE", "size": 201, "error": "", "lastProcessingStateChangeAt": 1477518645996, "lastSizeChangeAt": 1479413042495 }, "dynamic": true, "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, "internalListId": 220441, "deleteable": true, "listType": "DYNAMIC" }