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

# Retorna campos customizados relacionados a uma entidade

<Note>
  **🚀 API v2 (Recomendada)** - Este endpoint está disponível apenas na v2
</Note>


## OpenAPI

````yaml /openapi/openapi-v2.json GET /custom-fields/{parentType}/{parentId}
openapi: 3.0.0
info:
  title: Documentação de API
  version: '2.0'
servers:
  - url: https://backend-pied-prod.piedadmin.com.br/api/v2
security:
  - bearerAuth: []
tags:
  - name: Request
    description: Tudo sobre orçamentos ou pedidos
  - name: Equipment
    description: Tudo sobre equipamentos
  - name: Company
    description: Tudo sobre empresas de energia
  - name: Custom Field
    description: Tudo sobre campos customizados
  - name: Payments
    description: Tudo sobre pagamentos
paths:
  /custom-fields/{parentType}/{parentId}:
    get:
      tags:
        - Custom Field
      summary: Retorna campos personalizados relacionados a uma entidade
      parameters:
        - $ref: '#/components/parameters/customFieldParentType'
        - $ref: '#/components/parameters/customFieldParentId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/customFieldItem'
                  error:
                    type: object
                    default: null
        '429':
          $ref: '#/components/schemas/429'
        '500':
          $ref: '#/components/schemas/500'
      security:
        - bearerAuth: []
components:
  parameters:
    customFieldParentType:
      name: parentType
      in: path
      required: true
      description: Representa a entidade que será consultada
      schema:
        type: string
        enum:
          - order
          - budget
          - company
          - inverter
          - module
          - stringBox
          - complementaryEquipment
          - internalFinancing
    customFieldParentId:
      name: parentId
      in: path
      required: true
      description: Representa o ID do registro a ser consultado
      schema:
        type: string
  schemas:
    '429':
      description: >-
        hardLimit: O limite de requisições por hora foi ultrapassado. Tente
        novamente mais tarde / timeLimit: O limite de 1 minuto de processamento
        de requisição por hora foi atingido. Tente novamente mais tarde
    '500':
      description: Erro na API
    customFieldItem:
      example:
        id: '1'
        name: Código integração
        code: codeCrm
        description: Código referente a integração com o CRM
        input:
          type: string
          value: '0000'
      properties:
        id:
          type: string
          description: ID único, gerado pelo pied
        name:
          type: string
          description: Nome do campo
        code:
          type: string
          description: Código de identificação
        description:
          type: string
          description: Texto de ajuda
        input:
          type: object
          properties:
            type:
              type: string
              enum:
                - text
                - date
                - integer
                - decimal
                - currency
                - currencyGeneric
                - singleSelect
                - multiSelect
              description: Tipo do campo
            value:
              $ref: '#/components/schemas/customFieldValue'
    customFieldValue:
      oneOf:
        - type: string
          description: Texto aberto
          default: '0000'
        - type: integer
          description: Número inteiro
          default: 1
        - type: number
          description: Número flutuante
          default: 900.9
        - type: array
          description: Seleção de múltiplos items
          default:
            - 1
            - 2
            - 3
          items:
            type: number
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````