> ## Documentation Index
> Fetch the complete documentation index at: https://docs.oncanary.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Custom fields

> Add typed organization data to assets, locations, parts, and work orders.

Custom fields extend Canary's core resource model with organization-specific data. Definitions control the label, type, order, and behavior; values belong to individual records.

Administrators manage definitions. People with standard maintenance access can enter values on records they can edit.

## Supported resources and types

Custom fields are available for **Assets**, **Locations**, **Parts**, and **Work Orders**.

| Type            | Use                                    |
| --------------- | -------------------------------------- |
| One-line text   | Short identifiers or labels            |
| Multi-line text | Longer notes or specifications         |
| Number          | Decimal numeric values                 |
| Single select   | One value from an ordered option list  |
| Date            | Calendar date                          |
| Date and time   | Timezone-aware timestamp               |
| Link            | Complete HTTP, HTTPS, or telephone URI |

## Create a definition

1. Open **Settings > Custom fields**.
2. Choose the resource tab.
3. Select **Add field**.
4. Enter the exact label and choose a type.
5. For **Single select**, add one unique option per line in display order.
6. Choose field behavior.
7. Create the field.

Active labels must be unique within the resource type. The label also becomes the key exposed through the public API, so use a stable, descriptive name.

## Field behavior

* **Required** marks the definition as required on supported edit flows.
* **Unlisted** removes it from normal listed use while preserving values.
* **Include in recurrence** carries a work-order definition into recurring work.
* **Include in Request Portal** shows a work-order field on request portals; required fields remain required.

The recurrence and Request Portal options apply only to work-order fields.

## Reorder or edit fields

Use the up and down controls to set display order. Open **Edit** to change the label, type, options, or behavior. Review existing record values before changing a type or select options so future entries remain valid.

## Archive a definition

1. Open the resource tab.
2. Select **Archive** beside the field.
3. Confirm the archive action.

Archived definitions leave active forms while their stored values remain preserved. The current settings surface has no restore action for a custom-field definition.

## API use

The public API exposes definition IDs, labels, types, behavior, and resource values. Numeric IDs address definition lookup, update, and archive operations. Record `extraFields` objects use the visible field label as each value key; send values in the format required by the field type.

## Related pages

* [API resource model](/api-reference/resource-model)
* [API keys](/help/admin/api-keys)
* [Features and recovery](/help/admin/features-and-recovery)