Skip to main content
POST
Read Block Schemas

Headers

x-prefect-api-version
string

Body

application/json
block_schemas
BlockSchemaFilter · object | null

Filter BlockSchemas

offset
integer
default:0
Required range: x >= 0
limit
integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

Successful Response

id
string<uuid>
required
created
string<date-time> | null
required
updated
string<date-time> | null
required
checksum
string
required

The block schema's unique checksum

block_type_id
string<uuid> | null
required

A block type ID

fields
Fields · object

The block schema's field schema

block_type
BlockType · object | null

The associated block type

capabilities
string[]

A list of Block capabilities

version
string
default:non-versioned

Human readable identifier for the block schema