Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-031984301.2 MB
Custom Field

Get Custom Field Definition

Retrieves a Custom Field by identifier.

get/custom-field-definitions/{customFieldDefinitionId}

Query parameters

fieldsstring

A comma separated list of fields to include in the response. Every value in the list should either consist of a top-level property name (excluding the items envelope for endpoints returning lists) or refer to a property of a top-level property of type object, in the following form: "toplevelpropertyname.subpropertyname". When this query parameter is omitted, default resource representations are returned (excluding fields marked as optional). The same applies to nested objects when just specifying the top-level property name, without explicitly listing sub-property names. When specifying the fields query parameter, only the specified fields are returned. The id property is always returned.

Headers

Authorizationstring required

The bearer access token provided by Auth0.

X-LC-Tenantstring required

The identifier of the account where the request is executed.

Response

idstring required

The identifier of the Custom Field Definition, generated by the service.

namestring
<div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The display name of the Custom Field.</div>
keystring

The key of the Custom Field, used for querying purposes.

descriptionstring

The description of the Custom Field.

type'long' | 'double' | 'boolean' | 'date' | 'string' | 'checkbox' | 'longtext' | 'picklist' | 'multiSelectPicklist' nullable

The value type supported by this Custom Field.

pickListOptionsstring[]

Possible values if the type selected is "picklist" or "multiSelectPicklist".

resourceType'project' | 'customer' | 'vendor' | 'vendorOrderTemplate'

The resource type to which this Custom Field can be applied.

isReadOnlyboolean nullable
defaultValuestring

Specifies a default value for this Custom Field. This is required if the "isReadOnly" field is True.

isMandatoryboolean nullable

Specifies if this Custom Field is mandatory when creating a resource of the supported type.