GET
/
v1
/
{workspace}
/
schema
/
cURL
curl -X GET "https://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

200
application/json

Successfully retrieved list of schemas

The response is of type object.