GET
/
custom-fields
List custom fields
curl --request GET \
  --url https://core.ravenna.ai/api/custom-fields \
  --header 'x-ravenna-api-token: <api-key>'
{
  "items": [
    {
      "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
      }
    }
  ],
  "nextCursor": "<string>",
  "totalCount": 123
}

Authorizations

x-ravenna-api-token
string
header
required

Query Parameters

system
boolean
skip
number | null
Required range: x >= 1
offset
number | null
Required range: x >= 0
cursor
string | null
limit
number | null
default:100
Required range: 1 <= x <= 10000
set
string | null
sortBy
string | null
sortDirection
enum<string> | null
Available options:
asc,
desc
groupBy
string | null
groupDirection
enum<string> | null
Available options:
asc,
desc
workspaceId
string | null

Response

Successful response

items
object[]
required
totalCount
number
required
nextCursor
string