Skip to main content
GET
The tenant's field groups, with how many fields each holds and which model section it lands in.

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
code
string
name
string
description
string
display_order
string
is_collapsed_by_default
string
row_version
string
fields
string
section
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

code
string<character varying>
Maximum string length: 60
description
string<text>
display_order
integer<integer>
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
fields
integer<bigint>
id
string<uuid>

Note: This is a Primary Key.

is_collapsed_by_default
boolean<boolean>
name
string<character varying>
Maximum string length: 150
row_version
integer<bigint>
section
string<text>