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

# Listar integrações

> Lista as integrações da conta, das mais recentes para as mais antigas, com [paginação](https://docs.olie.ai/api-reference/general/pagination). Aceita os filtros `type` e `is_active`. As credenciais nunca são retornadas; veja [Integrações](https://docs.olie.ai/guides/integrations/overview).



## OpenAPI

````yaml /api-reference/openapi.json get /api/management/integrations
openapi: 3.0.0
info:
  title: Olie API
  version: 1.0.0
  description: >
    # Introdução 👋


    Olá! Esta é a documentação oficial da API da [olie.ai](https://olie.ai/).
    Aqui você encontra as referências e exemplos de uso dos nossos endpoints.


    Para uma visão completa, recomendamos fortemente que você leia a
    [documentação oficial](https://docs.olie.ai/api-reference/introduction). Lá
    estão detalhados tópicos essenciais como
    [autenticação](https://docs.olie.ai/api-reference/introduction/authentication),
    [estrutura de
    respostas](https://docs.olie.ai/api-reference/general/response-structure),
    [paginação](https://docs.olie.ai/api-reference/general/pagination) e outros
    guias de integração.


    No Postman, esta coleção foca nas informações específicas de cada requisição
    (endpoints, parâmetros e exemplos), servindo como apoio rápido para testes e
    desenvolvimento.
servers:
  - url: https://api.olie.ai
security:
  - BearerAuth: []
paths:
  /api/management/integrations:
    get:
      tags:
        - integrations
      summary: Listar integrações
      description: >-
        Lista as integrações da conta, das mais recentes para as mais antigas,
        com [paginação](https://docs.olie.ai/api-reference/general/pagination).
        Aceita os filtros `type` e `is_active`. As credenciais nunca são
        retornadas; veja
        [Integrações](https://docs.olie.ai/guides/integrations/overview).
      parameters:
        - name: type
          in: query
          description: >-
            Filtra pelo conector: `whatsapp_cloud`, `whatsapp_evolution` ou
            `whatsapp_evolution_managed`.
          schema:
            type: string
          example: ''
        - name: is_active
          in: query
          description: 'Filtra pela situação: `true` (ativas) ou `false` (pausadas).'
          schema:
            type: string
          example: ''
        - name: page
          in: query
          description: Número da página a ser retornada. Começa em 1.
          schema:
            type: string
          example: ''
        - name: perPage
          in: query
          description: Quantidade de itens exibidos por página.
          schema:
            type: string
          example: ''
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                description: Resposta com a página de integrações.
                type: object
                properties:
                  response:
                    type: boolean
                    description: Sempre `true` em caso de sucesso.
                  meta:
                    type: object
                    description: Dados da paginação.
                    properties:
                      current_page:
                        type: integer
                        description: Página atual.
                      from:
                        type: integer
                        description: >-
                          Posição do primeiro item da página; `null` quando a
                          página está vazia.
                      to:
                        type: integer
                        description: >-
                          Posição do último item da página; `null` quando a
                          página está vazia.
                      last_page:
                        type: integer
                        description: Número da última página.
                      per_page:
                        type: integer
                        description: Quantidade de itens por página.
                      total:
                        type: integer
                        description: Total de itens encontrados.
                  integrations:
                    type: array
                    description: Integrações da página atual.
                    items:
                      description: Integração da conta.
                      type: object
                      properties:
                        id:
                          type: string
                          description: ID (UUID) da integração.
                          format: uuid
                        type:
                          type: string
                          enum:
                            - whatsapp_cloud
                            - whatsapp_evolution
                            - whatsapp_evolution_managed
                            - fake
                            - fake_storage
                          description: >-
                            Conector da integração: `whatsapp_cloud` (WhatsApp
                            Cloud, Meta), `whatsapp_evolution` (Evolution em
                            servidor próprio), `whatsapp_evolution_managed`
                            (WhatsApp hospedado pela Olie); `fake` e
                            `fake_storage` existem só em ambientes de teste.
                        name:
                          type: string
                          description: >-
                            Nome que identifica a conexão para a equipe; `null`
                            quando não definido.
                        config:
                          type: object
                          description: >-
                            Configurações da integração; as chaves presentes
                            variam conforme o conector. `null` quando não há
                            configuração.
                          properties:
                            base_url:
                              type: string
                              description: >-
                                Endereço (URL) do servidor Evolution; presente
                                só em `whatsapp_evolution`.
                            outbound_sender_prefix:
                              type: boolean
                              description: >-
                                Quando `true`, cada mensagem enviada por uma
                                pessoa sai precedida do nome de quem escreveu.
                            history_import_limit:
                              type: integer
                              enum:
                                - 0
                                - 10
                                - 25
                                - 50
                                - 100
                                - null
                              description: >-
                                Quantidade de mensagens anteriores recuperadas
                                ao abrir um canal: `0` (desligado), `10`, `25`,
                                `50` ou `100`.
                            graph_version:
                              type: string
                              description: >-
                                Versão da Graph API da Meta, no formato `vNN.N`
                                (ex.: `v21.0`); sem valor, usa a versão padrão
                                da plataforma.
                            inbound_funnel_step_id:
                              type: integer
                              description: >-
                                ID da etapa de funil onde um projeto é criado
                                quando chega mensagem de um contato sem conversa
                                ativa; sem valor, essas mensagens são ignoradas.
                            referral_form_id:
                              type: integer
                              description: >-
                                ID do formulário que recebe os dados de origem
                                de campanha (anúncio) da conversa.
                            referral_field_map:
                              type: object
                              description: >-
                                Relação entre cada dado do anúncio e o ID do
                                campo do formulário que o recebe; exige
                                `referral_form_id`.
                              properties:
                                ctwa_clid:
                                  type: integer
                                  description: >-
                                    ID do campo que recebe o identificador do
                                    clique no anúncio.
                                source_id:
                                  type: integer
                                  description: ID do campo que recebe o ID do anúncio.
                                source_type:
                                  type: integer
                                  description: ID do campo que recebe o tipo de origem.
                                headline:
                                  type: integer
                                  description: ID do campo que recebe o título do anúncio.
                                body:
                                  type: integer
                                  description: ID do campo que recebe o texto do anúncio.
                            allow_multiple_active_channels:
                              type: boolean
                              description: >-
                                Permite ou não mais de uma conversa ativa com o
                                mesmo contato nesta integração; ausente ou
                                `null`, vale o padrão da conta.
                            onboarding:
                              type: string
                              description: >-
                                Como a integração foi conectada;
                                `embedded_signup` quando foi pela conexão com a
                                Meta na plataforma.
                            waba_id:
                              type: string
                              description: >-
                                ID da conta comercial do WhatsApp (WABA) na
                                Meta; presente só em integração conectada pela
                                Meta.
                        is_active:
                          type: boolean
                          description: >-
                            Situação escolhida pela conta: `false` indica
                            integração pausada, que recusa as mensagens
                            recebidas.
                        connection_state:
                          type: string
                          enum:
                            - unknown
                            - connecting
                            - connected
                            - disconnected
                          description: >-
                            Estado da sessão com o provedor: `unknown` (o
                            provedor ainda não informou), `connecting`,
                            `connected` ou `disconnected`.
                        connection_state_changed_at:
                          type: string
                          description: >-
                            Data em que a sessão entrou no estado atual; `null`
                            se o provedor nunca informou.
                          format: date-time
                        frame_id:
                          type: string
                          description: ID (UUID) da conta à qual a integração pertence.
                          format: uuid
                        webhook_token:
                          type: string
                          description: >-
                            Token que compõe o endereço do webhook de entrada;
                            `null` em integrações que não recebem webhook.
                        webhook_url:
                          type: string
                          description: >-
                            Endereço a cadastrar no provedor para a entrega de
                            mensagens; `null` em integrações que não recebem
                            webhook.
                        created_at:
                          type: string
                          description: Data de criação.
                          format: date-time
                        updated_at:
                          type: string
                          description: Data da última alteração.
                          format: date-time
                        capabilities:
                          type: object
                          description: >-
                            O que a integração pode fazer, independentemente da
                            conversa; o estado da janela de cada conversa fica
                            em `capabilities` do canal.
                          properties:
                            reply_window:
                              type: object
                              description: >-
                                Janela de resposta do provedor; `null` quando o
                                provedor não tem janela.
                              properties:
                                hours:
                                  type: integer
                                  description: >-
                                    Duração da janela em horas, contada a partir
                                    da última mensagem do cliente (24 no
                                    WhatsApp Cloud).
                            templates:
                              type: boolean
                              description: >-
                                Indica se a integração envia templates
                                aprovados; só no WhatsApp Cloud conectado pela
                                Meta, que conhece a conta comercial (WABA).
                            typing:
                              type: boolean
                              description: >-
                                Indica se a integração mostra ao cliente que
                                alguém está digitando.
              example:
                response: true
                meta:
                  current_page: 1
                  from: 1
                  to: 2
                  last_page: 1
                  per_page: 30
                  total: 2
                integrations:
                  - id: b7a4c2d1-9e8f-4a6b-8c3d-2e1f0a9b8c7d
                    type: whatsapp_evolution_managed
                    name: Atendimento
                    config:
                      history_import_limit: 25
                    is_active: true
                    connection_state: connected
                    connection_state_changed_at: '2026-06-20T09:15:00.000000Z'
                    frame_id: 7c0e1d2f-3a4b-5c6d-7e8f-9a0b1c2d3e4f
                    webhook_token: Hd5wL8rY2cF6jG1aEuI4oT9kQ3vN7mBxZp0sK2tV6qR8nMbW
                    webhook_url: >-
                      https://api.olie.ai/api/management/channels/inbound/Hd5wL8rY2cF6jG1aEuI4oT9kQ3vN7mBxZp0sK2tV6qR8nMbW
                    created_at: '2026-06-20T09:00:00.000000Z'
                    updated_at: '2026-06-20T09:15:00.000000Z'
                    capabilities:
                      reply_window: null
                      templates: false
                      typing: true
                  - id: 5d2e8f1a-6b3c-4d7e-8f90-1a2b3c4d5e6f
                    type: whatsapp_cloud
                    name: WhatsApp oficial
                    config:
                      onboarding: embedded_signup
                      waba_id: '102030405060708'
                      graph_version: v21.0
                    is_active: true
                    connection_state: unknown
                    connection_state_changed_at: null
                    frame_id: 7c0e1d2f-3a4b-5c6d-7e8f-9a0b1c2d3e4f
                    webhook_token: Qm7xT2vB9nK4sH8dL1wR6yC0fJ5gAeU3iO7tZ2pV9kMbXc1N
                    webhook_url: >-
                      https://api.olie.ai/api/management/channels/inbound/Qm7xT2vB9nK4sH8dL1wR6yC0fJ5gAeU3iO7tZ2pV9kMbXc1N
                    created_at: '2026-06-18T12:00:00.000000Z'
                    updated_at: '2026-06-18T12:00:00.000000Z'
                    capabilities:
                      reply_window:
                        hours: 24
                      templates: true
                      typing: true
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````

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