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

# Listar colunas

> As colunas personalizadas ativas de contatos, empresas e negócios

As colunas personalizadas são os campos que a sua organização cria além dos fixos (nome, telefone, e-mail, empresa e tags). No painel, cada coluna de contato aparece na lista de **CRM > Contatos**.

Envie `entity` para ver só as de um tipo: `contact`, `company` ou `deal`. A `key` de cada coluna é o que você usa em `custom_fields` ao [criar ou atualizar um contato](https://docs.useintegra.com.br/api-reference/endpoint/crm-upsert-contact.md) ou um [negócio](https://docs.useintegra.com.br/api-reference/endpoint/crm-create-deal.md).

> [!NOTE]
>
> As rotas do CRM pedem o CRM ligado na organização. Com ele desligado, a resposta é `409`. Ligue no painel, em **CRM > Configurações**.


## OpenAPI

````yaml GET /api/v1/crm/fields
openapi: 3.1.0
info:
  title: Integra BFI API
  version: 1.0.0
  description: >
    <img src="/public/logo_dark.webp" alt="Integra" height="36"
    style="margin-bottom:16px" />


    A API da Integra para integrações externas.


    > [!tip]

    > **Copie a documentação completa para sua IA favorita:**

    > [Abrir página de cópia](/docs/markdown) ou baixe o [llm.txt](/llm.txt)


    ---


    ## Como começar


    ### 1. Gerar sua API Key


    Acesse o painel da Integra em **Settings > API Keys** e clique em **Nova API
    Key**.


    > [!important]

    > Copie a key gerada (`ik_live_...`) imediatamente: ela **só será exibida
    uma vez**.


    ### 2. Autenticar requests


    Envie o header `Authorization` em todas as chamadas:


    ```

    Authorization: Bearer ik_live_sua_key_aqui

    ```


    ### 3. Fazer sua primeira chamada


    ```bash

    curl -H "Authorization: Bearer ik_live_xxx" \
      https://api.useintegra.com.br/api/v1/campaigns
    ```


    > [!success]

    > Se a resposta for `200 OK` com JSON, sua integração está funcionando!


    ---


    ## Rate Limiting


    | Header | Descrição |

    |--------|-----------|

    | `X-RateLimit-Limit` | Limite total (60/min) |

    | `X-RateLimit-Remaining` | Requests restantes |

    | `X-RateLimit-Reset` | Timestamp de reset (epoch) |


    > [!warning]

    > Ao exceder **60 requests/minuto** por API Key, a API retorna status `429
    Too Many Requests`.


    ---


    ## Erros comuns


    | Status | Erro | Causa |

    |--------|------|-------|

    | `401` | Invalid API key | Key inválida ou revogada |

    | `403` | Forbidden | Key sem permissão para o recurso |

    | `429` | Rate limit exceeded | Excedeu 60 req/min |

    | `500` | Internal server error | Erro interno, contate o suporte |
servers:
  - url: https://api.useintegra.com.br
    description: Production
security:
  - ApiKey: []
tags:
  - name: Campaigns
    description: Gerenciamento de campanhas de voz e WhatsApp
  - name: Calls
    description: Histórico de chamadas
  - name: CRM
    description: 'CRM Integra da organização: funis, contatos, negócios e atividades'
  - name: Automations
    description: Dispara as automações com o gatilho Chamada pela nossa API
  - name: Meetings
    description: Reuniões que os agentes marcaram na agenda da organização
  - name: Webhooks
    description: Gerenciamento de webhooks para notificações em tempo real
paths:
  /api/v1/crm/fields:
    get:
      tags:
        - CRM
      summary: Listar os campos personalizados
      description: >-
        Os campos ativos da organização (os arquivados não vêm), na ordem da
        posição. É a definição: os valores ficam em custom_fields de cada
        contato e negócio.
      parameters:
        - schema:
            type: string
            enum:
              - contact
              - company
              - deal
            description: Só os desta entidade (sem ele, de todas)
          required: false
          name: entity
          in: query
      responses:
        '200':
          description: Os campos ativos
          content:
            application/json:
              schema:
                type: object
                properties:
                  fields:
                    type: array
                    items:
                      $ref: '#/components/schemas/CrmField'
                required:
                  - fields
        '400':
          description: Entidade inválida
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '401':
          description: Não autenticado
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '403':
          description: A chave não tem o escopo crm:read
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '409':
          description: >-
            O CRM está desligado na organização (ligue no painel, em CRM >
            Configurações)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
      security:
        - ApiKey: []
components:
  schemas:
    CrmField:
      type: object
      properties:
        id:
          type: string
        entity:
          type: string
          enum:
            - contact
            - company
            - deal
          description: contact, company ou deal
        key:
          type: string
          description: A chave que vai em custom_fields do contato e do negócio
        label:
          type: string
        type:
          type: string
          enum:
            - text
            - number
            - date
            - select
            - boolean
          description: >-
            text, number, date, select ou boolean. O tipo nunca muda depois de
            criado
        options:
          type:
            - array
            - 'null'
          items:
            type: string
          description: As opções, só em type select; null nos outros
        position:
          type: number
          description: A ordem na lista (menor primeiro)
        agent_writable:
          type: boolean
          description: O agente pode preencher o campo
        created_at:
          type: string
          description: Criação (UTC)
          example: '2026-11-02T14:00:00.000Z'
        updated_at:
          type: string
          description: Última mudança (UTC)
          example: '2026-11-02T14:00:00.000Z'
      required:
        - id
        - entity
        - key
        - label
        - type
        - options
        - position
        - agent_writable
        - created_at
        - updated_at
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'API Key da organização (Authorization: Bearer ik_live_xxx)'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.