Block types
Read Block Types
Gets all block types. Optionally limit return with limit and offset.
POST
/
api
/
block_types
/
filter
Headers
x-prefect-api-version
string
Body
application/json
block_types
object | null
Filter BlockTypes
block_schemas
object | null
Filter BlockSchemas
offset
integer
default: 0limit
integer
Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.
Response
200 - application/json
id
string
created
string | null
updated
string | null
name
string
requiredA block type's name
slug
string
requiredA 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: falseProtected block types cannot be modified via API.
Was this page helpful?