USuspacy
fields

Get available fields list

Returns all fields configured for a specific CRM entity type.

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

Request

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
  }
]

Changes

No recorded changes to this operation across all 2 revisions of this API.