GEgetmaintainx
Custom Fields

List custom fields

Changed on
get/customfields/{entity}

Request

  • Base URL
    https://api.getmaintainx.com/v1
  • Auth
    HTTP bearer

Path parameters

entity'assets' | 'locations' | 'parts' | 'workOrders' | 'vendors' | 'purchaseOrders' | 'lineItemPurchaseOrders' required

Type of entity

Headers

x-organization-idinteger

Required if using a multi organizations token

Response

Successfully fetched the custom fields

idnumber required

ID of the custom field

labelstring required

The label of the custom field

sortOrderinteger required

A weighted value used to sort the custom fields. Fields are sorted lowest to highest. This is different from sortIndex.

type'oneline' | 'multiline' | 'number' | 'singleSelect' | 'date' | 'datetime' | 'link' required
requiredboolean nullable

This field is marked as required. This only affect the frontend.

unlistedboolean nullable

This field is marked as unlisted. Once unlisted it will only be editable through the Rest API. When the custom field contains data, it will be displayed in the frontend; otherwise, it will remain hidden.

optionsstring[]

The possible choices to the field (if applicable).

Example response

[
  {
    "id": 1,
    "label": "Date Purchased",
    "sortOrder": 25
  }
]

Changes

  • 222e6fad7c1fRevision changes
    • warning

      added the new link enum value to the / response property for the response status

    • info

      added the new optional header request parameter x-organization-id

    • info

      added the new enum value lineItemPurchaseOrders to the path request parameter entity

    • info

      added the new enum value purchaseOrders to the path request parameter entity

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status