GET
/
request-type-custom-fields
/
{id}
Get request type custom field by ID
curl --request GET \
  --url https://core.ravenna.ai/api/request-type-custom-fields/{id} \
  --header 'x-ravenna-api-token: <api-key>'
{
  "id": "<string>",
  "order": 123,
  "private": true,
  "requestTypeId": "<string>",
  "customField": {
    "id": "<string>",
    "workspaceId": "<string>",
    "key": "<string>",
    "label": "<string>",
    "description": "<string>",
    "required": true,
    "system": true,
    "config": null,
    "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
    }
  },
  "customFieldId": "<string>",
  "ticketField": "TITLE",
  "required": true,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "parentId": "<string>"
}

Authorizations

x-ravenna-api-token
string
header
required

Path Parameters

id
string
required

Response

Successful response

id
string
required
order
number
required
private
boolean
required
requestTypeId
string
required
customField
object
required
customFieldId
string
required
ticketField
enum<string> | null
required
Available options:
TITLE,
DESCRIPTION,
STATUS,
PRIORITY,
REQUESTER,
ASSIGNEE,
APPROVERS,
FOLLOWERS
required
boolean
required
createdAt
string
required
updatedAt
string
required
parentId
string | null
required