Skip to main content
GET
/
api
/
CustomFields
/
{entityId}
List Custom Field Settings.
curl --request GET \
  --url https://api.example.com/api/CustomFields/{entityId}
[
  {
    "id": 123,
    "dbTypeId": 123,
    "agencyName": "<string>",
    "dataType": "<string>",
    "isActive": true,
    "name": "<string>",
    "nameWithoutSpaces": "<string>",
    "usePredefinedValues": true,
    "isSearchable": true,
    "mandatory": true,
    "multiLine": true,
    "editable": true,
    "editableViaGrids": true,
    "numberTypeId": 123,
    "numberTypeName": "<string>",
    "enableDropdownBooleanSearching": true,
    "stringTypeId": 123,
    "stringTypeName": "<string>"
  }
]

Path Parameters

entityId
integer<int32>
required

Query Parameters

onlyActive
boolean
default:false

Response

200 - application/json

OK

id
integer<int32>
dbTypeId
integer<int32>
agencyName
string | null
dataType
string | null
isActive
boolean
name
string | null
nameWithoutSpaces
string | null
usePredefinedValues
boolean
isSearchable
boolean
mandatory
boolean
multiLine
boolean
editable
boolean
editableViaGrids
boolean
numberTypeId
integer<int32>
numberTypeName
string | null
enableDropdownBooleanSearching
boolean
stringTypeId
integer<int32>
stringTypeName
string | null