GET
/
api
/
block_types
/
{id}
{
  "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

Path Parameters

id
string
required

The block type ID

Response

200
application/json
Successful Response

An ORM representation of a block type

id
string
required
created
string | null
required
updated
string | 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.