Skip to main content
GET
List custom-field definitions

Authorizations

Authorization
string
header
required

Organization API key with an sk_live_ or sk_test_ prefix

Path Parameters

entity
enum<string>
required

MaintainX resource family for the custom-field definitions

Available options:
assets,
locations,
parts,
workOrders

Response

Active custom-field definitions in display order

id
integer<int32>
required
Required range: x >= 1
label
string
required
Minimum string length: 1
sortOrder
integer
required
Required range: x >= 0
type
enum<string>
required
Available options:
oneline,
multiline,
number,
singleSelect,
date,
datetime,
link
options
string[] | null
required
required
boolean | null
required
unlisted
boolean | null
required