For a given account, return all contacts that have been recently created. A paginated list of contacts will be returned to you, with a maximum of 100 contacts per page, as specified by the “count” parameter. Please Note There are 3 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 portal, and the “vid-offset” and “time-offset” fields which will let you know where you are in the list of contacts. You can then use the “vid-offset” and “time-offset” fields in the “vidOffset” and “timeOffset” parameters described below. The response is sorted in descending order by create date; the most recently created contact is returned first. Note: This endpoint returns contacts based on when they were created. If you need to check for recently modified records, use this endpoint.
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.
One method used to page through the recent contacts. Every call to this endpoint will return a time-offset value. This value is used in the timeOffset parameter of the next call to get the next page of contacts. The preferred method of paging.
Another method used to page through the recent 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.
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.
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 recently created
The response is of type object
.