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

# Listar campos personalizados



## OpenAPI

````yaml /api-reference/openapi.yaml get /company/{companyId}/crm-custom-fields
openapi: 3.0.3
info:
  title: Nupapia API — Integração
  version: '1.0'
  description: >
    Referência da API pública da Nupapia para integração de sistemas terceiros:
    conversas de chat e CRM (clientes). Gere um token de integração em
    **Configurações → Integrações** dentro da Nupapia e use-o como Bearer token
    em todas as chamadas abaixo.
servers:
  - url: https://api.nupapia.com.br/api
    description: Produção
security:
  - integrationToken: []
paths:
  /company/{companyId}/crm-custom-fields:
    get:
      tags:
        - CRM — Campos personalizados
      summary: Listar campos personalizados
      parameters:
        - $ref: '#/components/parameters/CompanyId'
      responses:
        '200':
          description: Campos personalizados
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CustomField'
components:
  parameters:
    CompanyId:
      name: companyId
      in: path
      required: true
      schema:
        type: integer
  schemas:
    CustomField:
      type: object
      properties:
        id:
          type: integer
        company_id:
          type: integer
        name:
          type: string
        key:
          type: string
        type:
          type: string
          enum:
            - text
            - number
            - date
            - select
            - multiselect
            - checkbox
        required:
          type: boolean
        options:
          type: array
          items:
            type: string
        active:
          type: boolean
  securitySchemes:
    integrationToken:
      type: http
      scheme: bearer
      bearerFormat: Token de integração (gerado em Configurações → Integrações)

````