Sign in
Custom Field

Find custom fields based on search parameters.

post/api/custom-fields/list

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip. Defaults to 0. Combine with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Take to page through a result set larger than one page.

Takeinteger

Number of records to return. Validation accepts 0 through 5000, but 0 is not a page size and what an endpoint does with it varies, so send a value from 1 to 5000.

Two cases differ. A request that supplies paging but leaves this field out takes this field's default of <b>50</b>. A request that supplies no paging at all is endpoint-specific — some define their own fallback — so it does not reliably mean any particular number of records. Either way the response says nothing about records it did not return, so send this explicitly whenever the size of the answer matters. Endpoints returning a paged envelope report totalCount and hasNextPage alongside the records; endpoints returning a bare array report neither, so page those with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Skip until a page comes back shorter than the value requested.

Request body

namestring nullable

Filter custom fields based on their name.

idsstring[] 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

List of custom fields matching the filters

idstring required

Unique id associated to this entity.

namestring required

Identifying name. Must be unique.

labelstring 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
requiredboolean required

Required.

optionsstring[] nullable

The options available (only applicable to dropdown and multiplechoicedropdown types).

prependstring nullable

Prepended text.

appendstring nullable

Appended text.

helpTextstring nullable

Help information that will be visble to the user.

Changes