[POST] .../v1/filter/getfields
Returns a list of fields that can be passed in filters[].field for the selected entity. Use this method before constructing dynamic filters for an API entity when the client needs the machine-readable list of allowed field names. The request requires entity_type as a Equal filter and returns standard filter fields plus custom additional fields when that entity and tariff support them. The endpoint reads metadata for the requested entity and does not modify user data; no entity-specific record permission is checked by this controller. Missing body, invalid or unsupported entity_type, unavailable additional-fields tariff option, metadata provider errors and storage failures 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. |
Filterable Fields
| Field | Type | Description |
|---|---|---|
| entity_type | string | Entity whose filterable fields should be returned. |
Request Example
{
"filters": [
{
"field": "entity_type",
"operator": "Equal",
"value": "Item"
}
]
}Response Parameters
| Name | Type | Description |
|---|---|---|
| ok | Boolean | Indicates whether the request completed successfully. |
| result | Array of FilterFieldInfo | Result array. |
Response Example
{
"ok": true,
"result": [
{
"field": "id",
"datatype": "int"
},
{
"field": "name",
"datatype": "string"
}
]
}