v1

latestOpenAPI 3.1.02026-07-1414757122.7 KB

fields

Get available fields list

Returns all fields configured for a specific CRM entity type.

get/crm/v1/entities/{entity}/fields

Response

Successful response

namestring

codestring

requiredboolean

editableboolean

showboolean

hiddenboolean

multipleboolean

fieldSectionIdinteger

default_valuestring

tooltipstring

typestring

entity_reference_idinteger

sortinteger

Example response

[
  {
    "name": "Source",
    "code": "source",
    "editable": true,
    "show": true,
    "fieldSectionId": 11,
    "default_value": "value",
    "tooltip": "example",
    "type": "entity_reference",
    "entity_reference_id": 123,
    "sort": 90
  }
]