Returns a paginated list of public field configurations for the current instance.
Request
GET /publicfield
Headers
| Header | Value |
|---|---|
Authorization | Bearer <token> |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
_sort | string | No | Field to sort by. Defaults to fieldName. |
_order | string | No | Sort direction: ASC or DESC. Defaults to ASC. |
_start | integer | No | Offset for pagination. Defaults to 0. |
_end | integer | No | Number of results to return. Defaults to 100. |
q | string | No | Filter by field name (case-insensitive substring match). |
Example Request
GET /publicfield?_sort=fieldName&_order=ASC&_start=0&_end=50Response
Returns a JSON array of public field objects. The X-Total-Count response header contains the total number of matching entries.
Response Fields
| Field | Type | Description |
|---|---|---|
id | integer | Unique public field ID. |
fieldId | string | Identifier of the field in the search index. |
fieldName | string | Human-readable name of the field. |
fieldType | string | Type of field: field or attribute. |
onListingPage | boolean | Whether the field is exposed on listing pages. |
onDetailPage | boolean | Whether the field is exposed on detail pages. |
onLandingPage | boolean | Whether the field is exposed on landing pages. |
user | string | Username of the person who last modified this entry. |
changed | string | ISO 8601 timestamp of the last modification. |
Example Response
[
{
"id": 1,
"fieldId": "price",
"fieldName": "Price",
"fieldType": "field",
"onListingPage": true,
"onDetailPage": true,
"onLandingPage": false,
"user": "[email protected]",
"changed": "2026-01-15T10:30:00+00:00"
}
]