List custom field definitions
List every custom field definition owned by the authenticated company.
A custom field is a user-defined attribute attached to one entity type (its parent_object) — for example an extra Batch # text field on orders or a Lab dropdown on packages. Once defined, the field becomes available on every record of that entity type, and callers populate it per-record through that entity's custom_data map on its own create/update endpoint (the numeric id returned here is the key used inside custom_data).
Pass parent_object to return only the fields for one entity type; omit it to return the company's fields across all entity types. This is a read-only settings lookup and changes nothing in inventory or compliance.
Required permission: settings_permissions_custom_fields.
Query parameters
Return only the fields attached to this entity type. Exact match against the parent object identifier; an unknown value returns an empty list. One of: assembly, batch, company, contact, invoice, order, package, product, purchase, request, return, shipment, stock_transfer, task. Omit to return the company's custom fields across all entity types. Example: ?parent_object=order
Response
List of custom field definitions
Changes
No recorded changes to this endpoint across all 1 revision of this API.