Namespace: hs/contactsLists

hs/contactsLists

A collection of methods related to the ContactsList API

Methods

hs/contactsLists.getById (list)Promise asyncstatic

Get contact list by ID

Name Type Description
list int

The id of the list to retrieve

Returns:
Type Description
Promise
Example
const hs = new HubspotClient(props);
hs.contactsList.getById(123412313).then(response => console.log(response))

hs/contactsLists.getById (list)Promise asyncstatic

Get contact list by ID

Name Type Description
list int

The id of the list to retrieve

Returns:
Type Description
Promise
Example
const hs = new HubspotClient(props);
hs.contactsList.getById(123412313).then(response => console.log(response))

hs/contactsLists.getContactsInList (list, properties)Promise asyncstatic

Get contacts in list

Name Type Description
list int

The id of the list to retrieve

properties object

Optional extra properties to add to the request - see developer docs

Returns:
Type Description
Promise
Example
const hs = new HubspotClient(props);
hs.contactsList.getContactsInList(123412313).then(response => console.log(response))

hs/contactsLists.getContactsInList (list, properties)Promise asyncstatic

Get contacts in list

Name Type Description
list int

The id of the list to retrieve

properties object

Optional extra properties to add to the request - see developer docs

Returns:
Type Description
Promise
Example
const hs = new HubspotClient(props);
hs.contactsList.getContactsInList(123412313).then(response => console.log(response))