Get all field definitions
https://{kibana_url}
- GET /api/cases/field_definitions
- GET /s/{space_id}/api/cases/field_definitions
Refer to Spaces for more information.
Returns a paginated list of field definitions (field library entries) for the given owner. Requires the Cases feature to be enabled in the space.
Query Parameters
-
ownerstring | stringrequired The application that owns the field definitions (for example
cases,observability, orsecuritySolution). Required.-
isGlobalboolean When true, returns only global field definitions (rendered on every case). When false, returns all definitions. Omit to return all.
-
pageinteger · default: 1 The page number to return.
-
perPageinteger · max: 100 · default: 20 The number of items to return. Limited to 100 items.
-
sortField The field to sort by. When omitted, results are sorted by
fieldDefinitionIdascending andsortOrderis ignored.-
Values:
nameownerisGlobaldisplayOrder -
searchstring · max: 1000 A case-insensitive substring to match against each definition's
nameanddescriptionfields. Definitions where neither field contains the substring are excluded.
Responses
Indicates a successful call.
-
fieldDefinitionsobjectrequired -
definitionstringrequired -
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 · min: 0 -
Position of a global field in the case details view. Assigned by the server and changed via the Field Library reorder controls.
-
fieldDefinitionIdstring · max: 36required -
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.
-
namestringrequired -
The field name. Must match the
nameproperty in the YAML definition and is unique per owner (case-insensitive). Immutable after creation. -
ownerstring · max: 50required -
The application that owns this field definition.
-
pageinteger · min: 1required -
The current page number.
-
perPageinteger · min: 1 · max: 100required -
The number of items per page.
-
totalinteger · min: 0required -
The total number of field definitions matching the query (before pagination).
The request is invalid. For example, the owner query parameter is missing or page/perPage are not integers.
-
errorstring -
messagestring -
statusCodeinteger
Authorization information is missing or invalid.
-
errorstring -
messagestring -
statusCodeinteger
The user does not have permission to read field definitions for the owner.
-
errorstring -
messagestring -
statusCodeinteger