provider Batch POST /crm/v3/objects/contacts/batch/read
@utdk/hubspot /crm/v3/objects/contacts/batch/read
Retrieve a batch of contacts
Retrieve a batch of contacts by ID (`contactId`) or unique property value (`idProperty`).
archived query
Whether to return only results that have been archived.
boolean

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.

post.crm.v3.objects.contacts.batch.readRead
POST/crm/v3/objects/contacts/batch/read
Retrieve a batch of contacts by ID (`contactId`) or unique property value (`idProperty`).

Whether to return only results that have been archived.

Input

When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.

required
required

Key-value pairs for setting properties for the new object.

required

Key-value pairs for setting properties for the new object and their histories.

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.post.crm.v3.objects.contacts.batch.readRead({
  "archived": false
})