Read Block Types

Gets all block types. Optionally limit return with limit and offset.

Headers

x-prefect-api-version

string

Body

application/json

block_schemas

object | null

Filter BlockSchemas

Show child attributes

block_schemas.block_capabilities

object | null

Filter criteria for BlockSchema.capabilities

Show child attributes

block_schemas.block_capabilities.all_

string[] | null

A list of block capabilities. Block entities will be returned only if an associated block schema has a superset of the defined capabilities.

block_schemas.block_type_id

object | null

Filter criteria for BlockSchema.block_type_id

Show child attributes

block_schemas.block_type_id.any_

string[] | null

A list of block type ids to include

block_schemas.id

object | null

Filter criteria for BlockSchema.id

Show child attributes

block_schemas.id.any_

string[] | null

A list of IDs to include

block_schemas.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

block_schemas.version

object | null

Filter criteria for BlockSchema.version

Show child attributes

block_schemas.version.any_

string[] | null

A list of block schema versions.

block_types

object | null

Filter BlockTypes

Show child attributes

block_types.name

object | null

Filter criteria for BlockType.name

Show child attributes

block_types.name.like_

string | null

A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.

block_types.slug

object | null

Filter criteria for BlockType.slug

Show child attributes

block_types.slug.any_

string[] | null

A list of slugs to match

limit

integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

offset

integer

default:

0

Required range: x > 0

Response

200 - application/json

created

string | null

required

id

string

required

name

string

required

A block type's name

slug

string

required

A block type's slug

updated

string | null

required

code_example

string | null

A code snippet demonstrating use of the corresponding block

description

string | null

A short blurb about the corresponding block's intended use

documentation_url

string | null

Web URL for the block type's documentation

is_protected

boolean

default:

false

Protected block types cannot be modified via API.

logo_url

string | null

Web URL for the block type's logo