> ## Documentation Index > Fetch the complete documentation index at: https://developer.zapsterapi.com/llms.txt > Use this file to discover all available pages before exploring further. # Listando Instâncias ## OpenAPI ````yaml GET /wa/instances openapi: 3.1.0 info: title: Zapster API description: '' version: 1.0.0 servers: - url: https://api.zapsterapi.com/v1 description: Produção security: [] tags: [] paths: /wa/instances: get: summary: Lista de Instâncias parameters: - name: lookup_key in: query description: Filtrar por identificador de pesquisa example: mylookupkey schema: type: string - name: page in: query description: Para registros páginados, define qual página quer buscar. example: 2 schema: type: number default: 1 - name: per_page in: query description: Limita o número de registros por página. example: 30 schema: type: number default: 20 - name: status in: query description: Filtrar por status example: connected schema: type: string enum: - disconnected - connected - offline responses: '200': description: Success content: application/json: schema: type: object properties: total: type: number description: Quantidade total de registros na conta do usuário instances: type: array description: Lista de instâncias encontradas items: $ref: '#/components/schemas/Instance' security: - bearer: [] components: schemas: Instance: type: object description: Estrutura de uma instância registrada na API. properties: created_at: type: string format: date-time description: Data e hora de criação da instância no formato ISO 8601. example: '2024-10-03T21:56:22.620Z' id: type: string description: Identificador único da instância. example: xy9rexnkwobmgg3tehgvs metadata: type: object description: Metadados adicionais armazenados como chave e valor. additionalProperties: oneOf: - type: string - type: number example: customer_id: '123456' customer_name: Joãozinho phone_number: '+5587989075555' connection_type: type: string enum: - unofficial - waba description: | Tipo de conexão da instância: - `unofficial`: conexão via QR code (padrão) - `waba`: conexão via API oficial do WhatsApp (Cloud API da Meta) example: unofficial name: type: string description: Nome da instância. example: MyNewInstance2 owner: type: object description: Informações sobre o proprietário da instância. properties: display_name: type: string nullable: true description: Nome de exibição do proprietário. Pode ser nulo. example: null id: type: string format: uuid description: Identificador único do proprietário. required: - id qrcode: type: string nullable: true description: QR Code da instância, caso disponível. example: null settings: $ref: '#/components/schemas/InstanceSettings' status: type: string enum: - connected - disconnected - offline description: Status atual da instância example: disconnected webhooks: type: array description: Lista de webhooks configurados para esta instância. items: type: object description: Configuração de um webhook associado à instância. properties: enabled: type: boolean description: Indica se o webhook está ativado. example: true events: type: array description: Lista de eventos que acionam este webhook. items: type: string enum: - group.created - group.participants_added - group.participants_demoted - group.participants_promoted - group.participants_removed - group.updated - instance.connected - instance.disconnected - instance.forbidden - instance.mentioned - instance.qrcode - message.deleted - message.delivered - message.pinned - message.reaction - message.read - message.received - message.sent - message.unpinned - poll.created - poll.deleted - poll.updated example: - message.received id: type: string description: Identificador único do webhook. example: 2nenz69l0xbf0m3uu9tfo name: type: string description: Nome do webhook configurado. example: Webhook Name test_mode: type: boolean description: Indica se o webhook está em modo de teste. example: false test_url: type: string nullable: true description: URL de teste do webhook, se disponível. example: null url: type: string format: uri description: URL do webhook para onde os eventos serão enviados. example: https://webhook.mydomain.com required: - enabled - events - id - name - test_mode - url lookup_key: type: string description: Identificador de pesquisa criado anteriormente. example: ins_8j7wlxmpjlixx9mux5 required: - created_at - id - metadata - name - owner - settings - status - webhooks InstanceSettings: type: object description: | Objeto **opcional** de configurações da sua instância. properties: call_rejection: type: string description: | Define o comportarmento de rejeição de ligações. - `all` - Irá rejeitar todas ligações - `none` - Não irá rejeitar ligações. - `video_only` - Irá rejeitar apenas ligações de **vídeo**. - `audio_only` - Irá rejeitar apenas ligações de **audio**. enum: - all - none - video_only - audio_only delay_per_word: type: boolean description: > Define se o delay antes de enviar a mensagem deve ser baseado na quantidade de palavras. ℹ️ Limitado a no máximo **10 segundos** de espera. delete_chat_after_sent: type: boolean description: > ⚠️ *Esta função não está funcionando adequadamente, estamos trabalhando para regulariza-la.* Define se o chat/conversa deve ser limpo depois do envio da mensagem. Isso garante que o dispositivo fique acumulando mensagens a ponto de muitas vezes travar o dispositivo que foi conectado. message_delay: type: object description: > Define a configuração de delay antes do envio da mensagem, se configurado `delay_per_word` é ignorado. O tempo é gerado randomicamente entre os limites configurado (`min` e `max`). properties: enabled: type: boolean default: true max: type: integer description: >- Máximo de tempo em segundos que deve ser esperado antes do envio da mensagem. default: 10 min: type: integer description: >- Mínimo de tempo em segundos que deve ser esperado antes do envio da mensagem. default: 1 presence_behavior: type: string description: > Define o comportamento da presença (Online, Digitando..., Gravando...) da sua instância. - `only_composing` - Aprecerá "Online" apenas durante o envio da mensagem. (**recomendado**) - `always` - Aparecerá sempre online - `never` - Nunca aparecerá "Online" exceto quando necessário durante os envios (por boas práticas) enum: - only_composing - always - never read_confirmation: type: string description: | Define o comportamento de "confirmação de leitura". - `never` - Nunca irá confirmar a leitura - `always` - Sempre irá confirmar. enum: - never - always securitySchemes: bearer: type: http scheme: bearer ````