Sign in
cases

Get a field definition by ID

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/cases/field_definitions/{field_definition_id}</span></div>

Refer to Spaces for more information.

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

get/api/cases/field_definitions/{field_definition_id}

Path parameters

field_definition_idstring required

The identifier for the field definition.

Response

Indicates a successful call. Returns the field definition.

definitionstring 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.

descriptionstring

Optional human-readable description of the field's purpose.

displayOrderinteger

Position of a global field in the case details view. Assigned by the server and changed via the Field Library reorder controls.

fieldDefinitionIdstring 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.

isGlobalboolean

When true, this field is rendered in every case regardless of which template the case uses.

namestring required

The field name. Must match the name property in the YAML definition and is unique per owner (case-insensitive). Immutable after creation.

ownerstring required

The application that owns this field definition.

Changes

No changes recorded. 20 of the 176 revisions have no diff computed, so they could not be searched.