---
title: "Read Block Schema By Checksum"
method: GET
path: "/api/block_schemas/checksum/{checksum}"
tags: ["Block schemas"]
---

# Read Block Schema By Checksum

`GET /api/block_schemas/checksum/{checksum}`

## Request

- The document declares no server URL.
- Auth: none declared

## Path parameters

- `checksum` string, required: The block schema checksum

## Query parameters

- `version` string: Version of block schema. If not provided the most recently created block schema with the matching checksum will be returned.

## Headers

- `x-prefect-api-version` string

## Response `200`

Successful Response

- BlockSchema: An ORM representation of a block schema.
  - `id` string, uuid
  - `created` string, date-time
  - `updated` string, date-time
  - `checksum` string, required: The block schema's unique checksum
  - `fields` object: The block schema's field schema
  - `block_type_id` string, uuid, required: A block type ID
  - `block_type` BlockType: An ORM representation of a block type
    - `id` string, uuid
    - `created` string, date-time
    - `updated` string, date-time
    - `name` string, required: A block type's name
    - `slug` string, required: A block type's slug
    - `logo_url` string, uri: Web URL for the block type's logo
    - `documentation_url` string, uri: Web URL for the block type's documentation
    - `description` string: A short blurb about the corresponding block's intended use
    - `code_example` string: A code snippet demonstrating use of the corresponding block
    - `is_protected` boolean: Protected block types cannot be modified via API.
  - `capabilities` string[]: A list of Block capabilities
  - `version` string: Human readable identifier for the block schema

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/prefecthq/apis/prefect-versions-api.md) - [All operations](https://skmtc.dev/prefecthq/apis/prefect-versions-api/llms.txt) - [OpenAPI document](https://skmtc.dev/prefecthq/apis/prefect-versions-api/revisions/a7958ce57e96?raw)