v50

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

List Custom Field Definitions

Retrieves a list of all the custom field definitions.

get/custom-field-definitions

Query parameters

topinteger

The number of items to include inside the page.

skipinteger

The number of items that are skipped to reach the desired page.

locationstring[]

The identifiers of the resource folders. You can control the behavior by using the 'locationStrategy'.

locationStrategy'location' | 'lineage' | 'bloodline' | 'genealogy'

Options: <br> - location: all the resources located strictly in the folders from the 'location' parameter (default); <br> - lineage: all the resources located in the folders specified in the 'location' parameter, as well as the subfolders; <br> - bloodline: all the resources located in the folders specified in the 'location' parameter, as well as the ancestor folders; <br> - genealogy: the resources located in the folders specified in the 'location' parameter together with subfolders and ancestors.

sortstring

A comma separated list of fields used to sort the resources in the response. Each field can have a unary negative to imply descending sort order.

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.

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

Filters the custom field definitions by the resource type they apply to.

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

itemCountinteger required