Overview

Returns a comprehensive listing of all fields (properties) available on a specified Domain entity. This endpoint serves as a metadata discovery tool, providing detailed information about each field including its name, data type, length, whether it is required, whether it references a lookup/code list, and other structural attributes.

This is useful for API consumers who want to:

• Discover field names to use in Query, Insert, Update, and Upsert operations — field names are case-sensitive and must match exactly.
• Understand field types and constraints before constructing request payloads (e.g., data type, max length, precision, nullability, required status).
• Identify coded/lookup fields that require valid code values rather than free-text input. Fields where NeedsLookup or IsCodeList is true have a constrained set of valid values retrievable via the /{domain}/Codes endpoint.
• Identify association fields that reference related entities. The AssociationIDField property indicates the foreign key field name used to set the relationship by ID.
• Determine which fields are read-only — fields where IsDbGeneratedField is true are system-generated and cannot be set via the API.

The returned field list is filtered to exclude fields that have been hidden by your System Admininstrator via the Form Set configuration. The response reflects only fields accessible to API consumers.