Get a field definition by ID

Auth

Returns a single field definition by its ID. Requires the Cases feature to be enabled in the space.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
field_definition_id string · max length: 36 required: The identifier for the field definition.

Indicates a successful call. Returns the field definition.

application/json

definition string required: The field definition as a YAML string. New definitions are limited to 30 000 characters, but existing definitions created via internal tooling may be longer.
description string: Optional human-readable description of the field's purpose.
displayOrder integer · min: 0: Position of a global field in the case details view. Assigned by the server and changed via the Field Library reorder controls.
fieldDefinitionId string · max length: 36 required: Unique server-assigned identifier for the field definition (UUID). May be UUIDv4 for definitions created through the public API, or UUIDv5 for definitions created by internal migration processes.
isGlobal boolean: When true, this field is rendered in every case regardless of which template the case uses.
name string required: The field name. Must match the name property in the YAML definition and is unique per owner (case-insensitive). Immutable after creation.
owner string · max length: 50 required: The application that owns this field definition.

Authorization information is missing or invalid.

application/json

The user does not have permission to read field definitions for the owner.

application/json

The field definition was not found.

application/json