Skip to main content
GET
/
workspaces
/
{workspace_id}
/
case-fields
Error
A valid request URL is required to generate request examples
[
  {
    "id": "<string>",
    "description": "<string>",
    "nullable": true,
    "default": "<string>",
    "reserved": true,
    "options": [
      "<string>"
    ],
    "required_on_closure": false
  }
]
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
fastapiusersauth
string
cookie
required

Path Parameters

​
workspace_id
string<uuid>
required

Response

Successful Response

​
id
string
required
​
type
enum<string>
required

Read-only type for case field metadata.

Available options:
TEXT,
INTEGER,
NUMERIC,
DATE,
BOOLEAN,
TIMESTAMPTZ,
JSONB,
SELECT,
MULTI_SELECT,
UUID
​
description
string
required
​
nullable
boolean
required
​
default
string | null
required
​
reserved
boolean
required
​
options
string[] | null
​
kind
enum<string> | null

Semantic kind for case custom fields.

Controls how the field is rendered in the UI without changing the underlying SQL storage type.

Available options:
LONG_TEXT,
URL
​
required_on_closure
boolean
default:false