Get recently created contacts

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

crm.objects.contacts.read

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.

Required Parameters	How to use	Description
OAuth access token or private app access token	Authorization: Bearer {token} header	Used to authenticate the request. Please see this page for more details about authentication.

Optional Parameters	How to use	Description
Count	&count=X - Used in the request URL	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.
Time Offset	&timeOffset=X - Used in the request URL	Used in conjunction with the vidOffset parameter 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.
Contact Offset	&vidOffset=X - Used in the request URL	Used in conjunction with the timeOffset parameter 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.
Property	&property=X - Used in the request URL	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.
Property Mode	&propertyMode=x	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”.
Form Submission Mode	&formSubmissionMode=x	One of “all”, “none”, “newest”, “oldest” to specify which form submissions should be fetched. Default is “newest”.
List Memberships	&showListMemberships=x	Boolean "true" or "false" to indicate whether current list memberships should be fetched for the contact. Default is false.

Example URL: https://api.hubapi.com/contacts/v1/lists/all/contacts/recent?hapikey=demo&count=2

JSON

Developers

Get recently created contacts

GET /contacts/v1/lists/all/contacts/recent

Method Details

About

Jobs

Learn Inbound

Support

Locations