Sign in
cases

Get all field definitions

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</span></div>

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.

get/api/cases/field_definitions

Query parameters

string required
OR
string[] required

The application that owns the field definitions (for example cases, observability, or securitySolution). Required.

isGlobalboolean

When true, returns only global field definitions (rendered on every case). When false, returns all definitions. Omit to return all.

pageinteger

The page number to return.

perPageinteger

The number of items to return. Limited to 100 items.

sortField'name' | 'owner' | 'isGlobal' | 'displayOrder'

The field to sort by. When omitted, results are sorted by fieldDefinitionId ascending and sortOrder is ignored.

sortOrder'asc' | 'desc'

Determines the sort order.

searchstring

A case-insensitive substring to match against each definition's name and description fields. Definitions where neither field contains the substring are excluded.

Response

Indicates a successful call.

pageinteger required

The current page number.

perPageinteger required

The number of items per page.

totalinteger required

The total number of field definitions matching the query (before pagination).

Changes

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