Skip to main content
POST
/
api
/
block_types
/
filter
Read Block Types
curl --request POST \
  --url https://api.example.com/api/block_types/filter \
  --header 'Content-Type: application/json' \
  --data '
{
  "block_types": {
    "name": {
      "like_": "marvin"
    },
    "slug": {
      "any_": [
        "<string>"
      ]
    }
  },
  "block_schemas": {
    "operator": "and_",
    "block_type_id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "block_capabilities": {
      "all_": [
        "write-storage",
        "read-storage"
      ]
    },
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "version": {
      "any_": [
        "2.0.0",
        "2.1.0"
      ]
    }
  },
  "offset": 0,
  "limit": 123
}
'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "slug": "<string>",
    "logo_url": "<string>",
    "documentation_url": "<string>",
    "description": "<string>",
    "code_example": "<string>",
    "is_protected": false
  }
]

Headers

x-prefect-api-version
string

Body

application/json
block_types
BlockTypeFilter · object

Filter BlockTypes

block_schemas
BlockSchemaFilter · object

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

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.