Skip to main content
GET
/
custom-fields
/
{id}
Get custom field by ID
curl --request GET \
  --url https://core.ravenna.ai/api/custom-fields/{id} \
  --header 'x-ravenna-api-token: <api-key>'
{
  "id": "<string>",
  "workspaceId": "<string>",
  "key": "<string>",
  "label": "<string>",
  "description": "<string>",
  "required": true,
  "system": true,
  "config": "<any>",
  "type": "TEXT",
  "options": [
    {
      "id": "<string>",
      "value": "<string>",
      "order": 123,
      "description": "<string>",
      "color": "<string>",
      "icon": "<string>",
      "customFieldId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "_count": {
    "requestTypeCustomField": 123
  }
}

Authorizations

​
x-ravenna-api-token
string
header
required

Path Parameters

​
id
string
required

Response

Successful response

​
id
string
required
​
workspaceId
string
required
​
key
string
required
​
label
string
required
​
description
string | null
required
​
required
boolean
required
​
system
boolean
required
​
type
enum<string>
required
Available options:
TEXT,
TEXT_AREA,
NUMBER,
DATE,
BOOLEAN,
SELECT,
FILE_PICKER,
MULTI_SELECT,
USER_SELECT,
TAG_SELECT,
STATUS_SELECT,
USER_GROUP_SELECT,
PRIORITY_SELECT,
APPLICATION_SELECT,
APPLICATION_GROUP_SELECT,
DURATION
​
options
object[]
required
​
createdAt
string
required
​
updatedAt
string
required
​
config
any
​
_count
object
⌘I