Skip to main content
POST
Read Block Types

Headers

x-prefect-api-version
string

Body

application/json
block_types
BlockTypeFilter · object | null

Filter BlockTypes

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
name
string
required

A block type's name

Pattern: ^[^/%&><]+$
slug
string
required

A block type's slug

logo_url
string | null

Web URL for the block type's logo

documentation_url
string | null

Web URL for the block type's documentation

description
string | null

A short blurb about the corresponding block's intended use

code_example
string | null

A code snippet demonstrating use of the corresponding block

is_protected
boolean
default:false

Protected block types cannot be modified via API.