post-/automation/v4/flows/batch/read

POST /automation/v4/flows/batch/read

Copy endpoint

https://api.hubapi.com

Request Body

application/json required

interface ApiFlowBatchInput {
inputs:

ApiFlowBatchFetchFlowIdCoordinate

interface ApiFlowBatchFetchFlowIdCoordinate {
flowId: string;
type: "FLOW_ID";
}

[];
}

Responses

200 application/json

successful operation

interface BatchResponseApiFlow {
completedAt: string;
links?: { };
requestedAt?: string;
results:

ApiFlow

type ApiFlow = ApiContactFlow & {} | ApiPlatformFlow & {}

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

207 application/json

multiple statuses

interface BatchResponseApiFlowWithErrors {
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:

ApiFlow

type ApiFlow = ApiContactFlow & {} | ApiPlatformFlow & {}

[];
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;
}