Get Schema

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

Flag	Description	Default
`-h, --help`	Show help for the command	–
`-g, --slug string`	Schema slug to retrieve (required)	–
`--mode string`	Version mode (`draft` or `live`)	`live`
`-o, --output string`	Output 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

Pull SchemaDownload trigger payload schema definitions from a SuprSend workspace into local JSON files, one per slug, using the suprsend schema pull command.

⌘I

Getting Started with CLI

Updates and Versioning

Sync

Workflow

Template

Schema

Event

Preference Category

Translation

Syntax

Flags

Example

​Syntax

​Flags

​Example

Syntax

Flags

Example