Read a batch of services by internal ID, or unique property values

POST /crm/v3/objects/0-162/batch/read

Copy endpoint

https://api.hubapi.com

Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.

Parameters

query Query Parameters

Name	Type
`archived` Whether to return only results that have been archived.	boolean

Request Body

application/json required

interface BatchReadInputSimplePublicObjectId {
idProperty?: string;
inputs:

SimplePublicObjectId

interface SimplePublicObjectId {
id: string;
}

[];
properties: string[];
propertiesWithHistory: string[];
}

Responses

200 application/json

successful operation

interface BatchResponseSimplePublicObject29 {
completedAt: string;
errors?:

StandardError

Ye olde error

interface StandardError {
category: string;
context: { };
errors: ErrorDetail[];
id?: string;
links: { };
message: string;
status: string;
subCategory?: {};
}

[];
links?: { };
numErrors?: number;
requestedAt?: string;
results:

SimplePublicObject31

A simple public object.

interface SimplePublicObject31 {
archived: boolean;
archivedAt?: string;
createdAt: string;
id: string;
objectWriteTraceId?: string;
properties: { };
propertiesWithHistory?: { };
updatedAt: string;
}

[];
startedAt: string;
status: "CANCELED" | "COMPLETE" | "PENDING" | "PROCESSING";
}

default */*

An error occurred.

interface Error {
category: string;
context?: { };
correlationId: string;
errors?:

ErrorDetail

interface ErrorDetail {
code?: string;
context?: { };
in?: string;
message: string;
subCategory?: string;
}

[];
links?: { };
message: string;
subCategory?: string;
}