Search + K

Command Palette

Search for a command to run...

Sign In

Read a batch of projects

POST /crm/objects/v3/projects/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
boolean

Request Body

application/json required
interface BatchReadInputSimplePublicObjectId25 {
idProperty?: string;
inputs: SimplePublicObjectId25
interface SimplePublicObjectId25 {
id: string;
}
[]
;
properties: string[];
propertiesWithHistory: string[];
}

Responses

200 application/json

successful operation

interface BatchResponseSimplePublicObject27 {
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: SimplePublicObject29

A simple public object.

interface SimplePublicObject29 {
archived: boolean;
archivedAt?: string;
createdAt: string;
id: string;
objectWriteTraceId?: string;
properties: { };
propertiesWithHistory?: { };
updatedAt: string;
url?: 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;
}