Skip to main content
POST
Read Block Documents

Headers

x-prefect-api-version
string

Body

application/json
block_documents
BlockDocumentFilter · object | null

Filter BlockDocuments. Only BlockDocuments matching all criteria will be returned

block_types
BlockTypeFilter · object | null

Filter BlockTypes

block_schemas
BlockSchemaFilter · object | null

Filter BlockSchemas

include_secrets
boolean
default:false

Whether to include sensitive values in the block document.

sort
enum<string> | null
default:NAME_ASC

Defines block document sorting options.

Available options:
NAME_DESC,
NAME_ASC,
BLOCK_TYPE_AND_NAME_ASC
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
block_schema_id
string<uuid>
required

A block schema ID

block_type_id
string<uuid>
required

A block type ID

name
string | null

The block document's name. Not required for anonymous block documents.

Pattern: ^[^/%&><]+$
data
Data · object

The block document's data

block_schema
BlockSchema · object | null

The associated block schema

block_type_name
string | null

The associated block type's name

block_type
BlockType · object | null

The associated block type

block_document_references
Block Document References · object

Record of the block document's references

is_anonymous
boolean
default:false

Whether the block is anonymous (anonymous blocks are usually created by Prefect automatically)