> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yume.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Get custom fields



## OpenAPI

````yaml /openapi/settings.json get /v1/crm/settings/custom_fields/{id}/
openapi: 3.0.3
info:
  title: Yume API — Настройки
  version: 1.0.0
  description: Настройки приложения и пользовательские предпочтения.
servers:
  - url: https://api.yume.cloud
    description: Production
  - url: https://api.stage.yume.cloud
    description: Stage
security: []
paths:
  /v1/crm/settings/custom_fields/{id}/:
    get:
      tags:
        - custom_fields
      summary: Get custom fields
      operationId: custom_fields_retrieve
      parameters:
        - in: path
          name: id
          schema:
            type: integer
          required: true
        - $ref: '#/components/parameters/TenantId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomField'
          description: ''
      security:
        - jwtAuth: []
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: false
      schema:
        type: integer
      description: >-
        Компания, в контексте которой выполняется запрос — её id из `GET
        /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id
        доступа к данным не даёт. Без заголовка компания определяется по домену
        запроса.
  schemas:
    CustomField:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        key:
          allOf:
            - $ref: '#/components/schemas/CustomFieldKeyEnum'
          title: Ключ поля
        name:
          type: string
          title: Название
          maxLength: 255
        label:
          type: string
          title: Подпись
          maxLength: 255
        placeholder:
          type: string
          nullable: true
          title: Подсказка
          maxLength: 255
        required:
          type: boolean
          title: Обязательное
        table:
          type: boolean
          title: Показывать в таблице
        filter:
          type: boolean
          title: Показывать в фильтрах
        type:
          allOf:
            - $ref: '#/components/schemas/CustomFieldTypeEnum'
          title: Тип
        options:
          title: Варианты
      required:
        - id
        - key
        - label
        - name
        - type
    CustomFieldKeyEnum:
      enum:
        - client
        - service
        - inventory
        - inventory_car
        - inventory_scooter
        - inventory_motorcycle
        - inventory_set
        - inventory_group
        - rental_point
        - category
        - order
        - order_inventory
        - order_service
        - funnel_lead
        - workshop
        - document
        - template
      type: string
      description: |-
        * `client` - Клиент
        * `service` - Услуга
        * `inventory` - Инвентарь
        * `inventory_car` - Автомобиль
        * `inventory_scooter` - Самокат
        * `inventory_motorcycle` - Мотоцикл
        * `inventory_set` - Комплект
        * `inventory_group` - Группа инвентаря
        * `rental_point` - Точка проката
        * `category` - Категория
        * `order` - Аренда
        * `order_inventory` - Позиция аренды
        * `order_service` - Позиция услуги
        * `funnel_lead` - Лид
        * `workshop` - Сервис
        * `document` - Документ
        * `template` - Шаблон
    CustomFieldTypeEnum:
      enum:
        - string
        - html
        - integer
        - decimal
        - boolean
        - date
        - datetime
        - color
        - client
        - inventory
        - inventory_group
        - inventory_set
        - service
        - workshop
        - document
        - template
      type: string
      description: |-
        * `string` - Строка
        * `html` - HTML-текст
        * `integer` - Целое число
        * `decimal` - Дробное число
        * `boolean` - Да / нет
        * `date` - Дата
        * `datetime` - Дата и время
        * `color` - Цвет
        * `client` - Клиент
        * `inventory` - Инвентарь
        * `inventory_group` - Группа инвентаря
        * `inventory_set` - Комплект
        * `service` - Услуга
        * `workshop` - Сервис
        * `document` - Документ
        * `template` - Шаблон
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````