Manage custom fields on work orders for buyer and provider data.
Custom fields allow you to capture additional data on work orders beyond the standard fields. There are two types:
GET /workorders/{work_order_id}/custom_fields
Returns all custom fields and their values for a specific work order.
{
"results": [
{
"id": 129,
"name": "Store Number",
"type": "text",
"value": "5521",
"required": true,
"filled_by": "buyer"
},
{
"id": 130,
"name": "Serial Number",
"type": "text",
"value": null,
"required": true,
"filled_by": "provider"
}
]
}GET /workorders/{work_order_id}/custom_fields/{custom_field_id}
{
"id": 129,
"name": "Store Number",
"type": "text",
"value": "5521",
"required": true,
"filled_by": "buyer"
}PUT /workorders/{work_order_id}/custom_fields/{custom_field_id}
Update a buyer-defined custom field:
{
"value": "5522"
}Provider updates their required field:
{
"value": "SN-ABC-123456"
}Get all custom fields defined for your company.
GET /custom-fields
{
"results": [
{
"id": 129,
"name": "Store Number",
"type": "text",
"required": true,
"filled_by": "buyer",
"projects": [501, 502]
},
{
"id": 130,
"name": "Serial Number Captured",
"type": "text",
"required": true,
"filled_by": "provider",
"projects": [501]
},
{
"id": 131,
"name": "Installation Type",
"type": "dropdown",
"options": ["New Install", "Replacement", "Upgrade"],
"required": false,
"filled_by": "buyer",
"projects": []
}
]
}Prop
Type
When creating a work order, include custom field values:
{
"title": "Install POS Terminal",
"custom_fields": {
"results": [
{
"results": [
{ "id": 129, "value": "Store #5521" }
]
}
]
}
}Custom fields are typically configured in the Field Nation UI and associated with specific projects. Use the API to read the configuration and set/update values.
Provider custom fields are filled out by the technician during or after completing work. These are often used for:
If a provider custom field is marked as required, the work order cannot be marked complete until the provider fills in the value.
Last updated on