Get Existing Form Field Metadata

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Returns comprehensive metadata for form fields in any Origami domain that supports custom forms.

This endpoint is useful for building dynamic user interfaces that need to render forms programmatically, including field types, validation rules, visibility conditions, and available options.

Important: This is a read-only metadata endpoint. It never creates, modifies, or deletes database records. When newInstanceValues is provided, it creates a temporary in-memory instance solely for determining context-specific metadata - nothing is persisted to the database.

Query Params
string
required

The domain name for the form / screen definition

integer

Primary key of an existing record.

If provided, the endpoint returns metadata based on that record's actual context (state, coverage, etc.) and ignores newInstanceValues.

If omitted, the endpoint returns metadata for a hypothetical new record.

string

JSON object containing hypothetical values for metadata generation.

Only used when id is NOT provided.

Creates an in-memory instance (not persisted) to determine context-specific metadata. Used to simulate "what metadata would I get if these were the initial values?"

If id has been provided, then any user-provided value for newInstanceValues is ignored.

string

Comma-separated list of field names to include in the response. If omitted, returns all fields.

boolean
Defaults to false

If a fieldList is specified, should the system assume all other fields are not-editable

boolean

Exclude fields that are never applicable from the metadata result.

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json