Read Block Documents

Headers

x-prefect-api-version

string

Body

application/json

block_documents

object | null

Filter BlockDocuments. Only BlockDocuments matching all criteria will be returned

block_types

object | null

Filter BlockTypes

block_schemas

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

200 - application/json

string

required

created

string | null

required

updated

string | null

required

name

string | null

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

data

object

The block document's data

block_schema_id

string

required

A block schema ID

block_schema

object | null

The associated block schema

block_type_id

string

required

A block type ID

block_type_name

string | null

The associated block type's name

block_type

object | null

The associated block type

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)

APIs & SDK

Headers

Body

Response