---
title: "List custom fields"
method: GET
path: "/customfields/{entity}"
tags: ["Custom Fields"]
---

# List custom fields

`GET /customfields/{entity}`

## Path parameters

- `entity` 'assets' | 'locations' | 'parts' | 'workOrders' | 'vendors' | 'purchaseOrders' | 'lineItemPurchaseOrders', required

## Headers

- `x-organization-id` integer

## Response `200`

Successfully fetched the custom fields

- object[]
  - `id` number, required — ID of the custom field
  - `label` string, required — The label of the custom field
  - `sortOrder` integer, 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
  - `required` boolean, nullable — This field is marked as required. This only affect the frontend.
  - `unlisted` boolean, 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.
  - `options` string[] — The possible choices to the field (if applicable).

## Other responses

- `400` — OrganizationId was not provided
- `401` — Invalid token
- `404` — Could not find the specified custom field.

---

[API](https://skmtc.net/getmaintainx/apis/maintainx-api.md) · [All operations](https://skmtc.net/getmaintainx/apis/maintainx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getmaintainx/maintainx-api/revisions/ef9153fcac7c/schema)