Skip to main content
GET
/
block_schemas
/
{id}
Read Block Schema By Id
curl --request GET \
  --url https://api.example.com/block_schemas/{id}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "checksum": "<string>",
  "block_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fields": {},
  "block_type": {
    "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
  },
  "capabilities": [
    "<string>"
  ],
  "version": "non-versioned"
}

Documentation Index

Fetch the complete documentation index at: https://docs.prefect.io/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-prefect-api-version
string

Path Parameters

​
id
string<uuid>
required

The block schema id

Response

Successful Response

An ORM representation of a block schema.

​
id
string<uuid>
required
​
created
string<date-time> | null
required
​
updated
string<date-time> | null
required
​
checksum
string
required

The block schema's unique checksum

​
block_type_id
string<uuid> | null
required

A block type ID

​
fields
Fields · object

The block schema's field schema

​
block_type
BlockType · object

The associated block type

​
capabilities
string[]

A list of Block capabilities

​
version
string
default:non-versioned

Human readable identifier for the block schema