---
title: "Retrieves the active custom field definitions mapped to an entity type, in display order, including data type, multi-select flag, required flag, visibility, and the active options for Dropdown fields. Use the returned CustomFieldDefinitionID (or Name) to set values via the CustomFields collection on the Task and Project endpoints. Returns an empty list when the account's Custom Fields feature is disabled."
method: GET
path: "/api/CustomFieldDefinition"
tags: ["CustomFieldDefinition"]
---

# Retrieves the active custom field definitions mapped to an entity type, in display order, including data type, multi-select flag, required flag, visibility, and the active options for Dropdown fields. Use the returned CustomFieldDefinitionID (or Name) to set values via the CustomFields collection on the Task and Project endpoints. Returns an empty list when the account's Custom Fields feature is disabled.

`GET /api/CustomFieldDefinition`

## Query parameters

- `EntityTypeCode` string

## Response `200`

Returns the active custom field definitions mapped to the entity type (empty when the feature is disabled).

- CustomFieldDefinitionList — Collection of custom field definitions mapped to an entity type.
  - `CustomFieldDefinitions` CustomFieldDefinitionDetails[] — Active custom field definitions mapped to the requested entity type, in display order.
    - `CustomFieldDefinitionID` integer — Unique identifier for the custom field definition.
    - `Name` string — Display name of the custom field.
    - `Description` string — Optional description / help text for the field.
    - `DataTypeCode` string — Data type of the field. Values: ShortText, LongText, Number, Percentage, Currency, Duration, Date, Checkbox, Dropdown, User, Location.
    - `isMultiSelect` boolean — Whether the field allows multiple selections (Dropdown and User types only).
    - `isRequired` boolean — Whether a value is required when creating records of this entity type.
    - `DecimalPlaces` integer — Number of decimal places displayed for numeric types.
    - `UnitLabel` string — Unit suffix displayed after Number values (e.g. "km"), when configured.
    - `VisibilityCode` string — Field visibility. "Internal" = team members only; "Everyone" = also visible to external contacts.
    - `Options` CustomFieldOptionDetails[] — Active options for Dropdown fields, in display order. Empty for other data types.
      - `CustomFieldOptionID` integer — Unique identifier for the option.
      - `Name` string — Option display name.
      - `Color` string — Hex colour assigned to the option (e.g. "#F0AD4E"), or null.

## Other responses

- `400` — The EntityTypeCode is missing or not a valid entity type.

## Changes

- **2026-08-30** `e99843f3c878` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/avaza/apis/avaza-api-documentation/changes/api/CustomFieldDefinition/get.md)

---

[API](https://skmtc.dev/avaza/apis/avaza-api-documentation.md) · [All operations](https://skmtc.dev/avaza/apis/avaza-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/avaza/avaza-api-documentation/revisions/e99843f3c878/schema)