Skip to main content
GET
Get Schema

Authorizations

ServiceToken <token>
string
header
required

You can get Service Token from SuprSend dashboard -> Account Settings -> Service Tokens section.

Path Parameters

workspace
string
required

Workspace slug (staging, production, etc.)

schema_slug
string
required

Unique identifier of the schema

Query Parameters

mode
enum<string>
default:draft

Mode to fetch schema (draft or live). By default, draft schema is returned.

Available options:
draft,
live

Response

Successfully retrieved schema object

slug
string

Unique identifier for the schema

Example:

"new-order-placed"

name
string

Human-readable name of the schema

Example:

"Order Placed Event"

description
string | null

Description of the schema

Example:

"Schema for order placement action"

status
enum<string>

Status of returned schema. By default, draft version is returned. You can set mode=live to fetch the live schema.

Available options:
draft,
live
Example:

"draft"

hash
string

Git-like hash for version tracking

Example:

"382b707d4b1f8999a1xxxxxxxx"

json_schema
object | null

Structure of the workflow or event payload. Follows standard json schema specification. 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.

Example:
created_at
string<date-time>

When the schema was created

Example:

"2025-08-27T09:30:57.945326Z"

updated_at
string<date-time>

When the schema was last updated

Example:

"2025-08-29T15:37:37.650177Z"

committed_at
string<date-time> | null

When the schema was last committed. Only available for live schema.

Example:

null

commit_message
string | null

Last commit message. Only available for live schema.

Example:

null