---
title: "Get Schema"
method: GET
path: "/v1/{workspace}/schema/{schema_slug}/"
---

# Get Schema

`GET /v1/{workspace}/schema/{schema_slug}/`

Fetch the JSON schema corresponding to a slug.

## Path parameters

- `workspace` string, required
- `schema_slug` string, required

## Query parameters

- `mode` 'draft' | 'live'

## Response `200`

Successfully retrieved schema object

- object
  - `slug` string — Unique identifier for the schema
  - `name` string — Human-readable name of the schema
  - `description` string, nullable — Description of the schema
  - `status` 'draft' | 'live' — Status of returned schema. By default, draft version is returned. You can set `mode=live` to fetch the live schema.
  - `hash` string — Git-like hash for version tracking
  - `json_schema` object, nullable — Structure of the workflow or event payload. Follows standard [json schema specification](https://json-schema.org/draft/2020-12/schema). You can link this schema to a workflow or event to validate their input payload in API response. Same schema can be linked to multiple workflows and events.
  - `created_at` string, date-time — When the schema was created
  - `updated_at` string, date-time — When the schema was last updated
  - `committed_at` string, date-time, nullable — When the schema was last committed. Only available for live schema.
  - `commit_message` string, nullable — Last commit message. Only available for live schema.

## Other responses

- `401` — Authentication failed
- `404` — Schema not found

---

[API](https://skmtc.net/suprsend/apis/suprsend-api.md) · [All operations](https://skmtc.net/suprsend/apis/suprsend-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/suprsend/suprsend-api/versions/8bd2574bd2c3/schema)