Get contact lists

GET /contacts/v1/lists

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Return the contact lists for a portal.

By default, you will get up to 20 lists to you 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

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.
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. If the parameter is not 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&hapikey=demo&offset=0