---
title: "Gets all active custom field definitions to facilitate custom field entry"
method: GET
path: "/Reference/CustomFields"
tags: ["Reference"]
---

# Gets all active custom field definitions to facilitate custom field entry

`GET /Reference/CustomFields`

## Query parameters

- `includeInactive` boolean

## Response `200`

- CustomFieldDefinitionResult
  - `IntegerFieldDefinitions` IntegerFieldDefinition[], nullable
    - `Id` integer
    - `Label` string, nullable
    - `CandidatePage` boolean
    - `CompanyPage` boolean
    - `CompanyTierPage` boolean
    - `ContactPage` boolean
    - `JobPage` boolean
    - `IsActive` boolean
    - `MinValue` integer
    - `MaxValue` integer
  - `DecimalFieldDefinitions` DecimalFieldDefinition[], nullable
    - `Id` integer
    - `Label` string, nullable
    - `CandidatePage` boolean
    - `CompanyPage` boolean
    - `CompanyTierPage` boolean
    - `ContactPage` boolean
    - `JobPage` boolean
    - `IsActive` boolean
    - `MinValue` number
    - `MaxValue` number
    - `DecimalPlaces` integer
  - `TextBoxFieldDefinitions` TextBoxFieldDefinition[], nullable
    - `Id` integer
    - `Label` string, nullable
    - `CandidatePage` boolean
    - `CompanyPage` boolean
    - `CompanyTierPage` boolean
    - `ContactPage` boolean
    - `JobPage` boolean
    - `IsActive` boolean
    - `MaxLength` integer
    - `NumberOfLines` integer
    - `ShowScrollBar` boolean
  - `DateTimePickerFieldDefinitions` DateTimePickerFieldDefinition[], nullable
    - `Id` integer
    - `Label` string, nullable
    - `CandidatePage` boolean
    - `CompanyPage` boolean
    - `CompanyTierPage` boolean
    - `ContactPage` boolean
    - `JobPage` boolean
    - `IsActive` boolean
    - `MaxDate` string, date-time
    - `MinDate` string, date-time
    - `DateFormat` 'Date' | 'Time' | 'DateTime'
    - `TimeFormat` string, nullable
  - `CheckBoxFieldDefinitions` CustomFieldDefinition[], nullable
    - `Id` integer
    - `Label` string, nullable
    - `CandidatePage` boolean
    - `CompanyPage` boolean
    - `CompanyTierPage` boolean
    - `ContactPage` boolean
    - `JobPage` boolean
    - `IsActive` boolean
  - `ComboBoxFieldDefinitions` ComboBoxFieldDefinition[], nullable
    - `Id` integer
    - `Label` string, nullable
    - `CandidatePage` boolean
    - `CompanyPage` boolean
    - `CompanyTierPage` boolean
    - `ContactPage` boolean
    - `JobPage` boolean
    - `IsActive` boolean
    - `OrderAlphabetically` boolean
    - `ComboValues` CustomComboValue[], nullable
      - `CustomFieldId` integer
      - `ComboValueId` integer
      - `Value` string, nullable
      - `Order` integer
      - `Active` boolean
  - `MultiSelectListBoxFieldDefinitions` MultiSelectListBoxFieldDefinition[], nullable
    - `Id` integer
    - `Label` string, nullable
    - `CandidatePage` boolean
    - `CompanyPage` boolean
    - `CompanyTierPage` boolean
    - `ContactPage` boolean
    - `JobPage` boolean
    - `IsActive` boolean
    - `OrderAlphabetically` boolean
    - `MultiSelectValues` MultiSelectValue[], nullable
      - `CustomFieldId` integer
      - `ValueId` integer
      - `Value` string, nullable
      - `ShortName` string, nullable
      - `Order` integer
      - `Active` boolean
  - `CategorisedMultiSelectFieldDefinitions` CategorisedMultiSelectFieldDefinition[], nullable
    - `Id` integer
    - `Label` string, nullable
    - `CandidatePage` boolean
    - `CompanyPage` boolean
    - `CompanyTierPage` boolean
    - `ContactPage` boolean
    - `JobPage` boolean
    - `IsActive` boolean
    - `Categories` CustomCategory[], nullable
      - `CustomFieldId` integer
      - `CategoryId` integer
      - `Name` string, nullable
      - `Active` boolean
      - `Values` CategoryValues[], nullable
        - `CategoryId` integer
        - `CategoryValueId` integer
        - `Value` string, nullable
        - `Active` boolean
  - `NoteControlFieldDefinitions` CustomFieldDefinition[], nullable
    - `Id` integer
    - `Label` string, nullable
    - `CandidatePage` boolean
    - `CompanyPage` boolean
    - `CompanyTierPage` boolean
    - `ContactPage` boolean
    - `JobPage` boolean
    - `IsActive` boolean

## Other responses

- `401` — Unauthorized

---

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