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

# Listar conexões Telegram

> Lista as contas Telegram conectadas.



## OpenAPI

````yaml /telegram-api/api-reference/openapi-telegram.json get /v1/telegram/instances
openapi: 3.0.3
info:
  title: Notifique API — Telegram
  description: >-
    Envie mensagens Telegram e gerencie conexões. Autentique com `Authorization:
    Bearer sk_live_...` ou `x-api-key`.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - ntfTgBearerAuth: []
  - ntfTgApiKeyHeader: []
tags:
  - name: Mensagens
    description: Enviar e gerenciar mensagens
  - name: Instâncias
    description: Criar e conectar bots ou contas USER
  - name: Chats
    description: Listar chats
paths:
  /v1/telegram/instances:
    get:
      tags:
        - Instâncias
      summary: Listar conexões Telegram
      description: Lista as contas Telegram conectadas.
      operationId: ntfTg_getV1TelegramInstances
      parameters:
        - name: page
          in: query
          description: Número da página.
          schema:
            type: string
        - name: limit
          in: query
          description: Itens por página.
          schema:
            type: string
        - name: status
          in: query
          description: Filtrar por status da instância.
          schema:
            type: string
        - name: search
          in: query
          description: Busca por nome ou @ do bot.
          schema:
            type: string
      responses:
        '200':
          description: >-
            `data` contém instâncias com `id`, `name`, `status`, `createdAt`,
            `updatedAt`, `mode` (`BOT` / `USER`) e `botUsername` quando
            aplicável. `pagination` traz totais.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfTg_TelegramInstanceListEnvelope'
              example:
                success: true
                data:
                  - id: clxx_inst
                    name: Suporte
                    status: ACTIVE
                    createdAt: '2026-04-01T12:00:00.000Z'
                    updatedAt: '2026-04-01T12:05:00.000Z'
                    mode: BOT
                    botUsername: '@meubot'
                pagination:
                  total: 1
                  page: 1
                  limit: 20
                  totalPages: 1
        '401':
          description: Chave ausente ou inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfTg_ErrorResponse'
              example:
                success: false
                error: Unauthorized
                message: Invalid or missing API Key
                code: UNAUTHORIZED
        '402':
          description: Workspace suspenso ou plano expirado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfTg_ErrorResponse'
              example:
                success: false
                error: Payment Required
                message: Plan expired or suspended
                code: WORKSPACE_BLOCKED
        '403':
          description: Sem escopo **telegram:instances:list**.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfTg_ErrorResponse'
              example:
                success: false
                error: Forbidden
                message: 'Missing scope: telegram:instances:list'
                code: FORBIDDEN
components:
  schemas:
    NtfTg_TelegramInstanceListEnvelope:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/NtfTg_TelegramInstanceRow'
        pagination:
          type: object
          properties:
            total:
              type: integer
            page:
              type: integer
            limit:
              type: integer
            totalPages:
              type: integer
    NtfTg_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: 'Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).'
        message:
          type: string
          description: >-
            Mensagem legível para exibir ao usuário (localizada via
            Accept-Language / x-locale quando aplicável).
        code:
          type: string
          description: >-
            Código estável da API v1 (enum). Sempre presente em erros. Use com o
            status HTTP para decidir retry ou correção. Ver [Respostas de
            erro](/guides/conceitos/resposta-de-erros).
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
      required:
        - success
        - error
        - message
        - code
    NtfTg_TelegramInstanceRow:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        status:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        mode:
          type: string
          nullable: true
        botUsername:
          type: string
          nullable: true
  securitySchemes:
    ntfTgBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Authorization: Bearer sk_live_xxxxx'
    ntfTgApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````