Skip to main content
POST
Read a batch of properties

Supported products

Authorizations

Authorization
string
header
required

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

Path Parameters

objectType
string
required

The type of CRM object for which properties are being retrieved. This is a required path parameter.

Query Parameters

locale
string

A string specifying the locale to use for the response. This can be used to tailor the response to a specific language or region.

Body

application/json
archived
boolean
required

Specifies whether the property is archived.

dataSensitivity
enum<string>
required

Indicates the sensitivity level of the data, such as 'non_sensitive', 'sensitive', or 'highly_sensitive'.

Available options:
highly_sensitive,
non_sensitive,
sensitive
inputs
object[]
required

An array of property names to be included in the batch read operation. Each item in the array is a reference to a PropertyName object.

Response

successful operation

completedAt
string<date-time>
required

The timestamp indicating when the batch operation was completed.

results
object[]
required

An array of Property objects representing the results of the batch operation.

startedAt
string<date-time>
required

The timestamp indicating when the batch operation began processing.

status
enum<string>
required

The current status of the batch operation, with possible values being CANCELED, COMPLETE, PENDING, or PROCESSING.

Available options:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

A collection of URLs linking to documentation or resources related to the batch operation.

requestedAt
string<date-time>

The timestamp indicating when the batch operation was requested.

Last modified on September 9, 2026