Get dynamic contact lists (smart lists)

GET /contacts/v1/lists/dynamic

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Get dynamic lists for a portal.

Dynamic lists automatically update themselves when new contacts are created or are updated, meaning that you can't manually add contacts to dynamic lists.

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. Defaults to 20, with a maximum of 250. Values higher than 250 will be treated as 250.
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/dynamic?count=1&hapikey=demo&offset=0