List Schemas

GET

{workspace}

schema

List Schemas

curl -X GET "https://management-api.suprsend.com/v1/{workspace}/schema/" \
  --header 'Authorization: ServiceToken <token>' \
  --header 'Content-Type: application/json'

{
  "meta": {
    "count": 5,
    "limit": 10,
    "offset": 0
  },
  "results": [
    {
      "slug": "new-order-placed",
      "name": "Order Placed Event",
      "description": "Schema for order placement action",
      "status": "draft",
      "hash": "382b707d4b1f8999a1xxxxxxxx",
      "json_schema": {
        "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
      },
      "created_at": "2025-08-27T09:30:57.945326Z",
      "updated_at": "2025-08-29T15:37:37.650177Z",
      "committed_at": null,
      "commit_message": null
    }
  ]
}

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.)

Query Parameters

mode

enum<string>

default:draft

Specify if you want to fetch draft or live schema.

Available options:

draft,

live

Response

Successfully retrieved list of schemas

meta

object

Metadata related to pagination information

Show child attributes

meta.count

integer

Total number of schemas matching the query

Example:

5

meta.limit

integer

Number of results returned per page

Example:

10

meta.offset

integer

Offset value passed in the request

Example:

0

results

object[]

Array of schemas

Show child attributes

results.slug

string

Unique identifier for the schema

Example:

"new-order-placed"

results.name

string

Human-readable name of the schema

Example:

"Order Placed Event"

results.description

string | null

Description of the schema

Example:

"Schema for order placement action"

results.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"

results.hash

string

Git-like hash for version tracking

Example:

"382b707d4b1f8999a1xxxxxxxx"

results.json_schema

object

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:

{
  "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
}

results.created_at

string<date-time>

When the schema was created

Example:

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

results.updated_at

string<date-time>

When the schema was last updated

Example:

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

results.committed_at

string<date-time> | null

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

Example:

null

results.commit_message

string | null

Last commit message. Only available for live schema.

Example:

null

Get SchemaFetch the JSON schema corresponding to a slug.

⌘I

List Schemas

curl -X GET "https://management-api.suprsend.com/v1/{workspace}/schema/" \
  --header 'Authorization: ServiceToken <token>' \
  --header 'Content-Type: application/json'

{
  "meta": {
    "count": 5,
    "limit": 10,
    "offset": 0
  },
  "results": [
    {
      "slug": "new-order-placed",
      "name": "Order Placed Event",
      "description": "Schema for order placement action",
      "status": "draft",
      "hash": "382b707d4b1f8999a1xxxxxxxx",
      "json_schema": {
        "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
      },
      "created_at": "2025-08-27T09:30:57.945326Z",
      "updated_at": "2025-08-29T15:37:37.650177Z",
      "committed_at": null,
      "commit_message": null
    }
  ]
}

API Reference

WORKFLOWS

SCHEMAS

EVENTS

CATEGORIES

TRANSLATIONS

Authorizations

Path Parameters

Query Parameters

Response