Skip to main content
GET
The tenant's field definitions, with how many records have answered each (UI spec §34).

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
entity_type
string
entity_label
string
field_key
string
name
string
description
string
help_text
string
placeholder
string
data_type
string
reference_entity_type
string
custom_field_group_id
string
group_code
string
group_name
string
display_order
string
status
string
is_required
string
is_searchable
string
is_filterable
string
offline_available
string
retired_at
string
row_version
string
live_version_id
string
draft_version_id
string
version_number
string
answers
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

answers
integer<bigint>
custom_field_group_id
string<uuid>
data_type
string<character varying>
Maximum string length: 20
description
string<text>
display_order
integer<integer>
draft_version_id
string<uuid>
entity_label
string<character varying>
Maximum string length: 120
entity_type
string<character varying>

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

Maximum string length: 80
field_key
string<character varying>
Maximum string length: 80
group_code
string<character varying>
Maximum string length: 60
group_name
string<character varying>
Maximum string length: 150
help_text
string<text>
id
string<uuid>

Note: This is a Primary Key.

is_filterable
boolean<boolean>
is_required
boolean<boolean>
is_searchable
boolean<boolean>
live_version_id
string<uuid>
name
string<character varying>
Maximum string length: 150
offline_available
boolean<boolean>
placeholder
string<character varying>
Maximum string length: 200
reference_entity_type
string<character varying>

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

Maximum string length: 80
retired_at
string<timestamp with time zone>
row_version
integer<bigint>
status
string<character varying>
Maximum string length: 20
version_number
integer<integer>