v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB

Guidance

List valid icons and colors

Returns the allowlists used when creating objects, tables, fields, and select options: valid icon keys, icon colors, option colors, and tag/relation modes. Sourced live from backend constants, so values never drift from validation. Accepts any valid API key.

get/public/v1/guidance/visual-options

Response

Visual option allowlists

iconKeysstring[] required

Valid icon keys for the icon/emoji field on objects and record types (the IconPicker set).

tagModesstring[] required

relationModesstring[] required

Example response

{
  "iconKeys": [
    "home",
    "users",
    "briefcase",
    "rocket"
  ],
  "iconColors": [
    {
      "name": "blue",
      "value": "#60a5fa"
    }
  ],
  "optionColors": [
    {
      "name": "blue",
      "value": "#60a5fa"
    }
  ],
  "tagModes": [
    "singleSelect",
    "multiSelect"
  ],
  "relationModes": [
    "single",
    "multi"
  ]
}