Get contacts in a list - HubSpot docs

{ "contacts": [ { "vid": 123, "canonical-vid": 123, "merged-vids": [ 123 ], "portal-id": 123, "is-contact": true, "addedAt": 123, "properties": {}, "form-submissions": [ {} ], "identity-profiles": [ {} ], "merge-audits": [ {} ] } ], "has-more": true, "vid-offset": 123 }

Parâmetros de caminho

list_id

integer

obrigatório

Unique identifier for the list you're looking for.

Parâmetros de consulta

count

integer

padrão:20

This parameter lets you specify the amount of contacts to return in your API call. The default for this parameter is 20 contacts. The maximum amount of contacts you can have returned is 100.

Intervalo obrigatório: x <= 100

vidOffset

integer

Used to page through the contacts. Every call to this endpoint will return a vid-offset value. This value is used in the vidOffset parameter of the next call to get the next page of contacts.

property

string[]

If you include the "property" parameter, then the properties in the "contact" object in the returned data will only include the property or properties that you request.

propertyMode

enum<string>

padrão:value_only

One of "value_only" or "value_and_history" to specify if the current value for a property should be fetched, or the value and all the historical values for that property.

Opções disponíveis:

value_only,

value_and_history

formSubmissionMode

enum<string>

padrão:newest

One of "all", "none", "newest", "oldest" to specify which form submissions should be fetched.

Opções disponíveis:

all,

none,

newest,

oldest

showListMemberships

boolean

padrão:false

Boolean to indicate whether current list memberships should be fetched for the contact.

Resposta

200 - application/json

Successful response with contacts in the list

contacts

object[]

Show child attributes

has-more

boolean

vid-offset

integer