Skip to main content
POST
Batch read

Supported products

Query Parameters

installPortalId
integer<int32>

The ID of an account that has installed your app. When set, only entries for that account are returned.

Body

application/json
inputs
string[]
required

The offsets (UUIDs) of the journal entries to fetch, up to 100 per request. Use the currentOffset values returned by other journal endpoints. If any value is not a valid UUID, the whole request is rejected with a 400. Offsets that can't be fetched don't fail the request: each one appears in errors with the offset in context.offset, and numErrors counts them. Offsets with no matching entry for your app (or for installPortalId when it is set) have category OBJECT_NOT_FOUND; other failures have INTERNAL_SERVER_ERROR. An empty list returns an empty result.

Response

successful operation

completedAt
string<date-time>
required

The date and time when the batch operation was completed, in ISO 8601 format.

results
object[]
required

An array of results from the batch operation, each represented by a JournalFetchResponse object.

startedAt
string<date-time>
required

The date and time when the batch operation started, in ISO 8601 format.

status
enum<string>
required

The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.

Available options:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

A map of link names to associated URIs, providing additional resources or information related to the batch operation.

requestedAt
string<date-time>

The date and time when the batch operation was requested, in ISO 8601 format.

Last modified on November 9, 2026