Configure Custom Fields

Custom Fields let you attach additional structured data to platform resources — drivers, vehicles, contacts, and more — without writing an extension. Fields are defined in the console settings panel, rendered inline on resource detail views, and returned automatically in API responses.

What You'll Build

A custom field group called Emergency Contact on the Driver resource, with three fields: a text input for the contact's name, a phone input for their number, and a select field for the relationship type.

Prerequisites

• FleetOps installed on your instance
• IAM permissions to access FleetOps Settings

Step 1 — Open the Custom Fields Manager

Step 2 — Create a Field Group

Fields must belong to a group — a named container that renders as a labelled section on the Driver detail view. You can create multiple groups per resource to organise related fields.

Step 3 — Add Custom Fields

Click Create new custom field inside the group. The field form opens.

Field 1 — Contact Name

Click Save.

Field 2 — Contact Phone

Click Save.

Field 3 — Relationship

Click Save.

All three fields now appear inside the Emergency Contact group. You can drag them to reorder, or click the pencil icon to edit any field at any time.

Available Field Types

Step 4 — Test the Fields on a Driver

Open any driver record in FleetOps → Resources → Drivers (or create a new driver). Scroll to the Emergency Contact section in the detail view. Your three fields render inline and are fully editable.

Enter values and save. The custom field data is stored alongside the standard driver record immediately.

Adding More Groups

You can add as many field groups as needed on the same resource. For example, you might add a second group called Licensing & Compliance with fields for licence number, expiry date, and licence class:

Both groups appear as separate sections on the Driver detail view.

Step 5 — Read Custom Fields via the API

Custom field values are included automatically in API responses. They are flattened directly onto the root resource object — not nested under a meta key. Each field key is the snake_case version of the field label you defined.

curl -X GET "https://api.fleetbase.io/v1/drivers/DRV-001" \
  -H "Authorization: Bearer flb_live_your_public_key_here" \
  -H "Content-Type: application/json"

Response:

{
  "id": "driver_01H...",
  "public_id": "DRV-001",
  "name": "Alex Tan",
  "phone": "+6591234567",
  "status": "active",
  "contact_name": "Sarah Tan",
  "contact_phone": "+6598765432",
  "relationship": "Spouse",
  "licence_number": "S1234567A",
  "licence_class": "B",
  "licence_expiry": "2028-06-30",
  "custom_fields": [
    "contact_name",
    "contact_phone",
    "relationship",
    "licence_number",
    "licence_class",
    "licence_expiry"
  ],
  "custom_field_values": [
    { "key": "contact_name", "value": "Sarah Tan" },
    { "key": "contact_phone", "value": "+6598765432" },
    { "key": "relationship", "value": "Spouse" }
  ]
}

Two reserved keys are always appended alongside the flattened values:

The field group structure (the visual groupings you created in the console) has no representation in the API response — groupings are purely a display concern.

Step 6 — Write Custom Fields via the API

Pass custom field values as top-level keys in the request body, using the same snake_case names they appear under in the response:

curl -X POST "https://api.fleetbase.io/v1/drivers" \
  -H "Authorization: Bearer flb_live_your_public_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Alex Tan",
    "phone": "+6591234567",
    "contact_name": "Sarah Tan",
    "contact_phone": "+6598765432",
    "relationship": "Spouse"
  }'

The same applies to PUT/PATCH requests when updating an existing driver. Only the keys you include are updated — omitting a custom field key leaves its existing value unchanged.

Editing and Deleting Fields

• Edit — click the pencil icon on any field to update its label, type, options, or settings. Changes apply immediately and existing stored values are preserved.
• Delete — click the trash icon to permanently remove a field and all its stored values across every record.

Next Steps

• The same workflow applies to Vehicles, Contacts, and other resource tabs in the Custom Fields Manager
• See Custom Fields for the full reference on field types, group settings, and grid layout
• For order-specific custom data, see the Order Configurations section in FleetOps