Retrieve the Data Dictionary for a Domain

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

Overview

Retrieves comprehensive schema and metadata documentation for all fields in a specified domain. This endpoint provides a machine-readable "data dictionary" that describes the structure, constraints, relationships, and business context of every field, enabling developers to understand the data model without consulting database documentation or system administrators.

The JSON response is equivalent to the Origami Data Dictionaries available in the Origami UI.

What it returns:

A complete technical specification of the domain's database schema, including:

Field Definitions - Every field with its data type, nullability, constraints, and system metadata
Business Context - Field labels, descriptions, aliases, and custom documentation notes
Relationships - Foreign key references to other tables and domains
Valid Values - Static code lists (dropdown options) for coded fields
Custom Fields - Extension table fields and client-defined custom properties
Related Tables & Domains - Other domains that reference this domain via foreign keys

Path Params
string
required

This is the Domain Name as identified in the response of the /api/Domains endpoint. Ex: the "Claims" domain (DomainID 1) would be referenced by its name value of Claim. Values are case-sensitive. Client-defined Domains should start with "Custom."

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