Skip to main content
POST
Retrieve a batch of partner client objects.

Supported products

Autorizaciones

Authorization
string
header
requerido

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

FlowAuthorization Code
Authorization URL
https://app.hubspot.com/oauth/authorize
Token URL
https://api.hubapi.com/oauth/v1/token
Scopes1
crm.objects.partner-clients.read

Parámetros de consulta

archived
boolean
predeterminado:false

Whether to return only results that have been archived.

Cuerpo

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[]
requerido
properties
string[]
requerido

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

propertiesWithHistory
string[]
requerido

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

idProperty
string

The name of a property whose values are unique for this object.

Respuesta

successful operation

A public object batch response object

completedAt
string<date-time>
requerido

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

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

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

status
enum<string>
requerido

The status of the batch processing request: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE"

Opciones disponibles:
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.

Última modificación el 6 de octubre de 2026