---
title: "Find custom fields based on search parameters."
method: POST
path: "/api/custom-fields/list"
tags: ["Custom Field"]
---

# Find custom fields based on search parameters.

`POST /api/custom-fields/list`

## Query parameters

- `Sort.Field` string
- `Sort.Dir` 'ascending' | 'descending' — Specify sorting direction.
- `Skip` integer
- `Take` integer

## Request body

- CustomFieldRequestFindParameters — Parameters used for searching/finding custom fields.
  - `name` string, nullable — Filter custom fields based on their name.
  - `ids` string[], nullable — Filter custom fields based on matching ids.
  - `module` 'item' | 'item_Make' | 'item_Buy' | 'customer' | 'vendor' | 'quote' | 'sales_Order' | 'job' | 'invoice' | 'purchase_Order' | 'receive_Order' | 'ship_Order' | 'quote_Part_LineItem' | 'sales_Order_Part_LineItem' | 'purchase_Order_Part_LineItem' | 'outsideProcessing_LineItem' | 'shipping_Part_LineItem' | 'invoice_Part_LineItem' | 'job_Operation' | 'ncr' | 'capa'
  - `type` 'text' | 'multilineText' | 'dropdown' | 'multipleChoiceDropdown' | 'integerNumber' | 'decimalNumber' | 'floatingPointNumber' | 'boolean' | 'list' | 'date' | 'multipleChoiceUser'

## Response `200`

List of custom fields matching the filters

- CustomFieldDto[]
  - `id` string, required — Unique id associated to this entity.
  - `name` string, required — Identifying name. Must be unique.
  - `label` string, required — Label name. Must be unique and cannot contain spaces.
  - `type` 'text' | 'multilineText' | 'dropdown' | 'multipleChoiceDropdown' | 'integerNumber' | 'decimalNumber' | 'floatingPointNumber' | 'boolean' | 'list' | 'date' | 'multipleChoiceUser', required
  - `module` 'item' | 'item_Make' | 'item_Buy' | 'customer' | 'vendor' | 'quote' | 'sales_Order' | 'job' | 'invoice' | 'purchase_Order' | 'receive_Order' | 'ship_Order' | 'quote_Part_LineItem' | 'sales_Order_Part_LineItem' | 'purchase_Order_Part_LineItem' | 'outsideProcessing_LineItem' | 'shipping_Part_LineItem' | 'invoice_Part_LineItem' | 'job_Operation' | 'ncr' | 'capa', required
  - `required` boolean, required — Required.
  - `options` string[], nullable — The options available (only applicable to dropdown and multiplechoicedropdown types).
  - `prepend` string, nullable — Prepended text.
  - `append` string, nullable — Appended text.
  - `helpText` string, nullable — Help information that will be visble to the user.

---

[API](https://skmtc.net/fulcrumpro/apis/fulcrum-publicapi.md) · [All operations](https://skmtc.net/fulcrumpro/apis/fulcrum-publicapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fulcrumpro/fulcrum-publicapi/versions/1b5649cff14a/schema)