Rippling: Get a metadata schema — response body

API reference · Contract 2026-10-28

SDK schema: Get a metadata schema — response body

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: allowed
best_practices	string	Optional	Type-specific implementation guidance.
common_mistakes	array	Optional	Common invalid inputs and their corrections.
common_mistakes[]	Model	Each item	Expand Get a metadata schema — response body — common mistakes item
config_schema	object	Required within parent	JSON Schema for a full deployable component config. Additional keys: allowed
description	string	Optional	Short description of the component type.
display_name	string	Optional	Human-readable component type name.
examples	array	Optional	Valid example configs for this component type.
examples[]	object	Each item	Example metadata component config. Additional keys: allowed
identifier_schema	object	Required within parent	JSON Schema for identifying an existing component. Additional keys: allowed
type	string	Required within parent	Metadata component type.
usage_guide	string	Optional	Type-specific authoring guidance.

Referenced models: Get a metadata schema — response body — common mistakes item