Skip to main content
POST
Retrieve a batch of contacts

Supported products

Autorisierungen

Authorization
string
header
erforderlich

The access token received from the authorization server in the OAuth 2.0 flow.

Abfrageparameter

archived
boolean
Standard:false

Whether to return only results that have been archived.

Body

application/json

Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property.

inputs
object[]
erforderlich
properties
string[]
erforderlich

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

propertiesWithHistory
string[]
erforderlich

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

idProperty
string

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.

Antwort

successful operation

A public object batch response object

completedAt
string<date-time>
erforderlich

The timestamp when the batch processing was completed, in ISO 8601 format.

results
object[]
erforderlich
startedAt
string<date-time>
erforderlich

The timestamp when the batch processing began, in ISO 8601 format.

status
enum<string>
erforderlich

The status of the batch processing request. The expected value is "COMPLETE".

Verfügbare Optionen:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

An object containing relevant links related to the batch request.

requestedAt
string<date-time>

The timestamp when the batch request was initially made, in ISO 8601 format.

Zuletzt geändert am 1. April 2026