Get

[POST] .../v1/field/get

Returns additional field information. Use this method to read additional field definitions before showing entity forms, validating custom field values or discovering user-defined fields for integrations. The response returns field id, saved key, display name, target entity type, data type, metadata, custom/system flag and required flag. The request body is required and supports filters plus the selector fields ids, keys, entity_type, search and required; sort_orders supports id, key and name. The caller must have additional field select permission and the account tariff must allow additional fields. Missing body, invalid entity_type, denied permission, disabled tariff option, invalid filters or sorting, cache errors and database errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
search String Optional Search string for the name and key fields.
sort_orders Array of BaseSortColumn Optional Output parameter sorting by id, key or name.

Filterable Fields

Field Type Description
entity_type string Entity the field is linked to.
id int Field ID array.
key string
keys string Field key array.
required bool Required-field filter: true for required fields, false for optional fields, null for all fields.

Request Example

{
  "filters": [
    {
      "field": "entity_type",
      "operator": "Equal",
      "value": "Item"
    },
    {
      "field": "required",
      "operator": "Equal",
      "value": "true"
    }
  ],
  "sort_orders": [
    {
      "column": "name",
      "direction": "ASC"
    }
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Array of Field Result array.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 12,
      "key": "field_color_code",
      "name": "Color code",
      "entity_type": "Item",
      "data_type": "string",
      "metadata": "{\u0022mask\u0022:\u0022^[A-Z0-9]\u002B$\u0022}",
      "is_custom": true,
      "required": true
    }
  ]
}