GET
/
additional_fields
/
{type}
Get AdditionalFields by Types
curl --request GET \
  --url https://api.neobrain.io/{version}/additional_fields/{type} \
  --header 'Authorization: Bearer <token>'
[
  {
    "fieldId": 123,
    "externalFieldId": "external_field_code",
    "name": "Field Name",
    "isVisible": true,
    "type": "Select"
  }
]

Authorizations

​
Authorization
string
header
required

API token for the Authorization header parameter.

Headers

​
Accept-Language
string

Language identifier, using the ISO 639-1 specification. If none provided it will use the account default language. For additional info please access /v1/locales

Path Parameters

​
type
string
required

Resource identifier. Please check /v1/additional_fields for available types. Case sensitive

Response

Success

​
fieldId
integer

Field reference

​
externalFieldId
string

External field reference

Example:

"external_field_code"

​
name
string

Field label

Example:

"Field Name"

​
isVisible
boolean

Field visibility

Example:

true

​
type
string

Field type. Can hold one of the following values - Date, Select, Text. Case sensitive

Example:

"Select"