Custom Field List
List active Manage-app custom field definitions for asset imports.
GET
/api/v1/assets/custom-fieldsDescription
List active custom field definitions for use with Add Asset, Bulk Import, and Update Asset.
Filter by product_type or product_type_id to see only fields applicable to that device category.
File-type fields are excluded from the response. Fields with is_readonly true are listed for reference but cannot be set via write endpoints.
Currency fields use field_type currency. The currency code is fixed on the definition (see validation_rules). On write endpoints, send the amount only or { "amount": "..." } in custom_fields[].value.
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <access_token> | Yes |
| Content-Type | application/json | Yes |
Query Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| product_type | string | No | Laptop | Product type name (e.g. Laptop, Desktop, Smartphone). |
| product_type_id | integer | No | 4108 | Internal product type ID. Use instead of product_type when known. |
Response
| Field | Type | Description |
|---|---|---|
| message | string | Success message. |
| data | array | Active custom field definitions. |
| data[].field_label | string | Display label. |
| data[].placeholder | string | null | Placeholder text when configured. |
| data[].field_type | string | text, textarea, number, checkbox, date, datetime, select, multiselect, or currency. File types are excluded from API responses. |
| data[].options | object | array | null | Select/multiselect options when configured. |
| data[].is_required | boolean | Whether a value is required for applicable product types. |
| data[].is_readonly | boolean | When true, the field cannot be set via add, bulk-add, or update (API returns 422). |
| data[].default_value | string | null | Default value when configured. |
| data[].is_global | boolean | Whether the field applies to all product types. |
| data[].sort_order | integer | Display order. |
| data[].validation_rules | object | null | Additional validation rules when configured. For currency fields, includes the fixed currency code (e.g. currency_code). |
| data[].is_active | boolean | Whether the definition is active. |
Related Endpoints
Did this page help you?
Request
curl -X GET https://dev-api.unduit.com/api/v1/assets/custom-fields \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"Success Response
{
"data": [
{
"field_label": "Cost Center",
"placeholder": null,
"field_type": "text",
"options": null,
"is_required": true,
"is_readonly": false,
"default_value": null,
"is_global": false,
"sort_order": 0,
"validation_rules": null,
"is_active": true
},
{
"field_label": "Deployment Region",
"placeholder": null,
"field_type": "select",
"options": ["North America", "EMEA", "APAC"],
"is_required": false,
"is_readonly": false,
"default_value": null,
"is_global": true,
"sort_order": 1,
"validation_rules": null,
"is_active": true
},
{
"field_label": "Replacement Cost",
"placeholder": null,
"field_type": "currency",
"options": null,
"is_required": false,
"is_readonly": false,
"default_value": null,
"is_global": false,
"sort_order": 2,
"validation_rules": { "currency_code": "USD" },
"is_active": true
}
],
"message": "Custom field definitions retrieved successfully."
}