Authorizations
You can get Service Token from SuprSend dashboard -> Account Settings -> Service Tokens section.
Path Parameters
Workspace slug (staging, production, etc.)
Unique identifier of the schema
Query Parameters
Mode to fetch schema (draft or live). By default, draft schema is returned.
draft
, live
Response
Successfully retrieved schema object
Unique identifier for the schema
"new-order-placed"
Human-readable name of the schema
"Order Placed Event"
Description of the schema
"Schema for order placement action"
Status of returned schema. By default, draft version is returned. You can set mode=live
to fetch the live schema.
draft
, live
"draft"
Git-like hash for version tracking
"382b707d4b1f8999a1xxxxxxxx"
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.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": ["order_id", "amount"],
"properties": {
"order_id": { "type": "string" },
"amount": { "type": "string" }
},
"additionalProperties": true
}
When the schema was created
"2025-08-27T09:30:57.945326Z"
When the schema was last updated
"2025-08-29T15:37:37.650177Z"
When the schema was last committed. Only available for live schema.
null
Last commit message. Only available for live schema.
null