v53

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-076771,7565.2 MB
cases

Get the fields applicable to an existing case

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/{caseId}/fields</span></div>

Refer to Spaces for more information.

Returns the fields you can write to the case's extended_fields. The case determines the owner and any applied template. The response includes the owner's global fields (library-wide) and, if the case has a template, that template's fields. Requires the Cases feature to be enabled in the space.

get/api/cases/{caseId}/fields

Path parameters

caseIdstring required
Example:9c235210-6834-11ea-a78c-6ffb38a34414

The identifier for the case. To retrieve case IDs, use the search cases (_find) API. All non-ASCII characters must be URL encoded.

Response

Indicates a successful call.

Example response

{
  "fields": [
    {
      "control": "SELECT_BASIC",
      "key": "priority_as_keyword",
      "label": "Priority",
      "name": "priority",
      "type": "keyword"
    }
  ]
}