List organization custom fields

Retrieves all custom fields configured for organizations in the workspace.

What are Custom Fields? Custom fields allow you to capture additional information about organizations that matters to your company. These fields are flexible and can hold different types of data.

Supported field types:

Text: Single-line text input
Textarea: Multi-line text input
Number: Numeric values
Date: Date selection
Checkbox: Boolean true/false
Select: Single selection from predefined options
MultiSelect: Multiple selections from predefined options

Common use cases:

Industry classification (e.g., Technology, Healthcare, Finance)
Business relationship data (e.g., Contract type, Payment terms)
CRM-relevant information (e.g., Lead source, Account tier)
Individual extra info for special organization types

What is returned:

Field ID, name, description, type, and entity (always “Organization”)
Sort order (for display ordering)
Multilingual translations
Select options (for Select and MultiSelect types)

Note: Custom fields are especially useful in CRM and add organization management features with specific data points tailored to your business needs.

GET/administration/organization-settings/custom-fields

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Responses

200

Organization custom fields retrieved successfully

Array of OrganizationCustomFieldResponseDto

descriptionstringrequired

Description providing context about what information should be entered in this field.

entitystringrequired

Entity type identifier. Always "Organization" for organization custom fields. Used internally to scope fields to specific entity types.

idstringrequired

Unique identifier (UUID) for the custom field. Used to reference this field when setting values on organizations.

namestringrequired

Display name of the custom field. Shown as the field label in organization forms.

selectOptionsOrganizationCustomFieldSelectOptionDto[]required

Array of select options for Select and MultiSelect field types. Each option contains an ID, value, and translations. Empty array for other field types.

Show properties

Array of OrganizationCustomFieldSelectOptionDto

idstring

Optional unique identifier for the select option. If not provided, the value will be used as the identifier. Required when updating existing options.

translationsOrganizationCustomFieldSelectOptionTranslationDto[]required

Array of translations for multilingual support. Each translation contains a language code and translated display name. The system automatically shows the correct language based on user preferences.

Show properties

Array of OrganizationCustomFieldSelectOptionTranslationDto

languagestringrequired

ISO 639-1 language code for the translation (e.g., "en" for English, "de" for German)

namestringrequired

Translated display name for the select option in this language. Shown to users when selecting from dropdown options.

valuestringrequired

Display value for the select option. This is the value stored when the option is selected. Must be unique within the field.

sortnumberrequired

Numeric sort order for display purposes. Lower numbers appear first in organization forms. Determines the order in which fields are displayed.

translationsOrganizationCustomFieldTranslationDto[]required

Complete array of translations for the field name. Each translation contains the language code and localized name.

Show properties

Array of OrganizationCustomFieldTranslationDto

descriptionstring

Translated description of the custom field in this language. Provides context about what information should be entered.

languagestringrequired

ISO 639-1 language code for the translation (e.g., "en" for English, "de" for German)

namestring

Translated name of the custom field in this language. Used for multilingual display in organization forms.

typestringrequired

Field type enum value indicating the input type. Valid values: Text, Textarea, Number, Date, Checkbox, Select, MultiSelect.

Allowed:TextTextareaNumberDateCheckboxSelectMultiSelectCurrencyUrl

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Request

curl -X GET "https://leadtime.app/api/public/administration/organization-settings/custom-fields" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/administration/organization-settings/custom-fields", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/administration/organization-settings/custom-fields",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

[
  {
    "description": "Priority level for the organization",
    "entity": "Organization",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Priority Level",
    "selectOptions": [
      {
        "id": "option-1",
        "translations": [
          {
            "language": "en",
            "name": "High Priority"
          },
          {
            "language": "de",
            "name": "Hohe Priorität"
          }
        ],
        "value": "High Priority"
      }
    ],
    "sort": 1,
    "translations": [
      {
        "description": "Priority level for the organization",
        "language": "en",
        "name": "Priority Level"
      }
    ],
    "type": "Select"
  }
]