Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.suprsend.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve the full definition of a specific schema by its slug. Returns the JSON Schema object including type, properties, and validation rules. Requires --slug. Use --mode to switch between draft and live versions.

​
Syntax

suprsend schema get [flags]

​
Flags

FlagDescriptionDefault
-h, --helpShow help for the command–
-g, --slug stringSchema slug to retrieve (required)–
--mode stringVersion mode (draft or live)live
-o, --output stringOutput format (json, yaml)json
Use -o json for machine-readable JSON output, -o yaml for YAML.

​
Example

# Get a schema by slug
suprsend schema get --slug order-payload

# Get the draft version
suprsend schema get --slug order-payload --mode draft

# Get schema in YAML format
suprsend schema get --slug order-payload --output yaml

# Get schema from production workspace
suprsend schema get --slug order-payload --workspace production