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

# Retrieve a custom field



## OpenAPI

````yaml get /v1/custom-fields/{id}
openapi: 3.0.0
info:
  title: Kinbox API
  description: Kinbox public API
  version: '2.0'
  contact: {}
servers: []
security: []
tags: []
paths:
  /v1/custom-fields/{id}:
    get:
      tags:
        - v1CustomFields
      summary: Retrieve a custom field
      operationId: getCustomField
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFieldPublicDto'
components:
  schemas:
    CustomFieldPublicDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          description: Nome do campo
          example: CPF
        description:
          type: string
          description: Descrição para te ajudar a saber para que serve esse campo
          example: Serve para identificar o contato
        entity:
          type: string
          description: Descrição para te ajudar a saber para que serve esse campo
          enum:
            - contact
            - group
            - channel
            - session
            - user
            - product
            - task
            - deal
        placeholder:
          type: string
          description: >-
            Chave que identifica esse campo em vários lugares. Geralmente é o
            nome em lowercase
          example: cpf
        type:
          type: string
          description: O tipo de campo que será mostrado e parseado
          enum:
            - text
            - textarea
            - number
            - decimal
            - select
            - multi-select
            - boolean
            - date
            - day
            - datetime
            - json
        options:
          description: >-
            Em caso de ser o tipo select ou multi-select é necessário ter as
            opções específicas que podem ser selecionadas
          type: array
          items:
            $ref: '#/components/schemas/CustomFieldOption'
        isActive:
          type: boolean
        isDeleted:
          type: boolean
        invisible:
          type: boolean
          description: Se ativo não mostra no plugin de contato em uma conversa
        position:
          type: number
        isUniqueIdentifier:
          type: boolean
        isIntegration:
          type: boolean
          description: Se é um campo usado para uma integração
        showAlways:
          type: boolean
        requiredToResolve:
          type: boolean
          description: >-
            Caso ativo somente permite resolver conversa se esse campo estiver
            ativado
        resetOnNewCall:
          type: boolean
          description: Caso ativo quando for uma nova sessão esse campo será resetado.
      required:
        - id
        - name
        - type
        - isActive
        - isDeleted
        - invisible
        - position
        - isUniqueIdentifier
        - isIntegration
        - showAlways
        - requiredToResolve
        - resetOnNewCall
    CustomFieldOption:
      type: object
      properties:
        value:
          type: string
          description: Valor da opção
          example: pt-BR
        label:
          type: string
          description: Título que o valor representa
          example: Português
      required:
        - value
        - label

````