For a given account, return all contacts that have been created in the account. A paginated list of contacts will be returned to you, with a maximum of 100 contacts per page. Note: There are 2 fields here to pay close attention to: the “has-more” field that will let you know whether there are more contacts that you can pull from this account, and the “vid-offset” field which will let you know where you are in the list of contacts. You can then use the “vid-offset” field in the “vidOffset” parameter described below.
This parameter lets you specify the amount of contacts to return in your API call. The default for this parameter (if it isn't specified) is 20 contacts. The maximum amount of contacts you can have returned to you via this parameter is 100.
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.
May be included multiple times. By default, only a few standard properties will be included in the response data. If you include the 'property' parameter, then you will instead get the specified property in the response. This parameter may be included multiple times to specify multiple properties. NOTE: Contacts only store data for properties with a value, so records with no value for a property will not include that property, even if the property is specified in the request URL.
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. Default is value_only
.
One of all
, none
, newest
, oldest
to specify which form submissions should be fetched. Default is newest
.
Boolean true
or false
to indicate whether current list memberships should be fetched for the contact. Default is false
.
Successful response - For a given account, return all contacts that have been created in the account
The response is of type object
.