Skip to main content
GET

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:20

Maximum number of block rows to return.

Required range: 1 <= x <= 10000
order
enum<string>
default:desc

Sort direction on block id.

Available options:
asc,
desc
before
string | null

Return blocks before this cursor (opaque token from a prior page's list_metadata).

after
string | null

Return blocks after this cursor (opaque token from a prior page's list_metadata).

workflow_id
string | null

Filter to a single workflow id.

block_type
string | null

Filter by block type: extract, classify, split, parse, edit, or partition. These are the primitive-kind names recorded on the execution, which differ from the workflow block type enum (a classifier block records classify). An unknown value is rejected with 422.

from_date
string | null

Inclusive activity lower bound (YYYY-MM-DD, UTC).

to_date
string | null

Inclusive activity upper bound (YYYY-MM-DD, UTC).

Response

Successful Response

data
UsageBlockRecord · object[]
required
list_metadata
ListMetadata · object
required

Boundary resource IDs for page navigation.