GET
/
contacts
/
v1
/
lists
/
{list_id}
/
contacts
/
recent
Get recently added contacts from a list
curl --request GET \
  --url https://api.hubapi.com/contacts/v1/lists/{list_id}/contacts/recent
{
  "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,
  "time-offset": 123
}

Path Parameters

​
list_id
integer
required

Unique identifier for the list you're looking for.

Query Parameters

​
count
integer
default:20

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

Required range: x <= 100
​
timeOffset
integer

Used in conjunction with the vidOffset parameter to page through the recent contacts. Every call to this endpoint will return a time-offset value.

​
vidOffset
integer

Used in conjunction with the timeOffset parameter to page through the recent contacts. Every call to this endpoint will return a vid-offset value.

​
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>
default: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.

Available options:
value_only,
value_and_history
​
formSubmissionMode
enum<string>
default:newest

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

Available options:
all,
none,
newest,
oldest
​
showListMemberships
boolean
default:false

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

Response

200 - application/json

Successful response with recently added contacts

The response is of type object.