GET
/
api
/
block_types
/
slug
/
{slug}
/
block_documents

Headers

x-prefect-api-version
string

Path Parameters

slug
string
required

The block type name

Query Parameters

include_secrets
boolean
default: false

Whether to include sensitive values in the block document.

Response

200 - application/json
id
string
created
string | null
updated
string | null
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)