provider Basic GET /crm/v3/objects/contacts
@utdk/hubspot /crm/v3/objects/contacts
Retrieve contacts
Retrieve all contacts, using query parameters to specify the information that gets returned.
after query
The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
string
archived query
Whether to return only results that have been archived.
boolean
associations query
A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
array
limit query
The maximum number of results to display per page.
integer
properties query
A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
array
propertiesWithHistory query
A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
array

Try it

Authentication
Configure credentials for Contacts
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

get.crm.v3.objects.contactsGetpage
GET/crm/v3/objects/contacts
Retrieve all contacts, using query parameters to specify the information that gets returned.

The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.

Whether to return only results that have been archived.

A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.

The maximum number of results to display per page.

A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.

A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import hubspot from '@utdk/hubspot';

await hubspot.get.crm.v3.objects.contactsGetpage({
  "archived": false,
  "limit": 10
})