SUsuprsend

List Schemas

Retrieve a list of schemas in a workspace.

get/v1/{workspace}/schema/

Request

Path parameters

workspacestring required

Workspace slug (staging, production, etc.)

Query parameters

mode'draft' | 'live'

Specify if you want to fetch draft or live schema.

limitinteger

Number of schemas to return per page.

offsetinteger

Number of schemas to skip before starting to return results.

Response

Successfully retrieved list of schemas

Example response

{
  "meta": {
    "count": 5,
    "limit": 10
  },
  "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"
    }
  ]
}

Changes