Skip to content
Alter

Rippling: Extract existing metadata components — response body — component configs item

Extract existing metadata components: response body, field component_configs / item. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Extract existing metadata components — response body — component configs item

FieldTypePresenceDescription and constraints
$objectRootA metadata component config. The `type` field selects the concrete component schema. Fetch type-specific fields from GET /metadata/schema/?type=<TYPE>.
Additional keys: allowed
typestringRequired within parentMetadata component type, such as CUSTOM_OBJECT or CUSTOM_OBJECT_FIELD.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.

LinkedInTwitter