Custom fields
List Custom Fields
Returns all active custom field definitions for the organization.
GET /api/custom-fields
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
organizationId | number | session org | Override organization scope |
envelope | string | none | items: answer as { items, total, page, perPage }. Becomes the default on 2027-01-18. |
Example (cURL)
curl -X GET "$BASE_URL/api/custom-fields?envelope=items" \
-H "Authorization: Bearer $TOKEN" \
-H "Accept: application/json"Response
{
"items": [
{
"id": 1,
"organizationId": 1,
"name": "Data Center",
"fieldKey": "data_center",
"fieldType": "text",
"isRequired": false,
"displayOrder": 0,
"options": [],
"placeholder": "e.g. fsn1",
"helpText": "Primary data center location",
"showInTable": true,
"isActive": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z"
}
],
"total": 1,
"page": 1,
"perPage": 1
}List form: with envelope=items the list arrives as { items, total, page, perPage }. Without it the endpoint still answers the current form (a bare array of the same items), which is deprecated; { items, ... } becomes the default on 2027-01-18.
Only active fields (isActive: true) are returned, ordered by displayOrder.