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
Commit message describing the changes
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. Can be used to describe which action this schema is linked to.
"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
"live"
Git-like hash for version tracking
"382b707d4b1f8999a1xxxxxxxx"
updated json schema
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
"2025-09-01T18:35:00.270698Z"
Last commit message
"required fields updated"