Skip to main content
GET
The writable columns per administered entity, generated from the model.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

entity
string
column_name
string
label
string
data_type
string
is_required
string
is_nullable
string
default_value
string
is_immutable
string
references_entity
string
references_title_column
string
references_label
string
references_allows_create
string
scope_column
string
scope_target_column
string
allowed_values
string
sort_order
string
comment
string
section
string
section_label
string
section_hint
string
hint
string
widget
string
companion_column
string
is_hidden
string
companion_references_entity
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

allowed_values
string[]
column_name
string<character varying>
Maximum string length: 63
comment
string<text>
companion_column
string<character varying>
Maximum string length: 63
companion_references_entity
string<character varying>
Maximum string length: 80
data_type
string<character varying>
Maximum string length: 40
default_value
string<text>
entity
string<character varying>

Note: This is a Foreign Key to custom_field_scopes.entity.

Maximum string length: 80
hint
string<text>
is_hidden
boolean<boolean>
is_immutable
boolean<boolean>
is_nullable
boolean<boolean>
is_required
boolean<boolean>
label
string<character varying>
Maximum string length: 120
references_allows_create
boolean<boolean>
references_entity
string<character varying>
Maximum string length: 80
references_label
string<character varying>
Maximum string length: 120
references_title_column
string<character varying>
Maximum string length: 63
scope_column
string<character varying>
Maximum string length: 63
scope_target_column
string<character varying>
Maximum string length: 63
section
string<character varying>
Maximum string length: 60
section_hint
string<text>
section_label
string<character varying>
sort_order
integer<integer>
widget
string<character varying>
Maximum string length: 30