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

# Ler configurações

> Retorna as configurações de comportamento da instância.



## OpenAPI

````yaml /pt-br/api-reference/openapi.json get /instance/settings
openapi: 3.1.0
info:
  title: Zapfy API
  description: >-
    API de WhatsApp multi-tenant. Envie mensagens e gerencie webhooks por uma
    superfície única.
  version: 1.0.0
servers:
  - url: https://api.zapfy.io/v1
security:
  - accountToken: []
paths:
  /instance/settings:
    get:
      tags:
        - Instância
      summary: Ler configurações
      description: Retorna as configurações de comportamento da instância.
      responses:
        '200':
          $ref: '#/components/responses/InstanceSettings'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '502':
          $ref: '#/components/responses/Error'
      security:
        - instanceToken: []
components:
  responses:
    InstanceSettings:
      description: Configurações de comportamento da instância.
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                $ref: '#/components/schemas/InstanceSettingsResult'
    Error:
      description: Erro.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Instance not found
  schemas:
    InstanceSettingsResult:
      type: object
      required:
        - alwaysOnline
        - rejectCall
        - msgRejectCall
        - readMessages
        - ignoreGroups
        - ignoreStatus
      properties:
        alwaysOnline:
          type: boolean
          description: Mantém a instância sempre aparecendo como online.
          example: false
        rejectCall:
          type: boolean
          description: Rejeita automaticamente chamadas recebidas.
          example: true
        msgRejectCall:
          type: string
          description: >-
            Mensagem enviada automaticamente ao rejeitar uma chamada. Usada
            apenas quando `rejectCall` é `true`.
          example: Não atendo chamadas por aqui.
        readMessages:
          type: boolean
          description: Marca automaticamente como lidas as mensagens recebidas.
          example: false
        ignoreGroups:
          type: boolean
          description: Ignora mensagens de grupos — não dispara webhook para elas.
          example: false
        ignoreStatus:
          type: boolean
          description: Ignora atualizações de status — não dispara webhook para elas.
          example: false
  securitySchemes:
    accountToken:
      type: http
      scheme: bearer
      description: Token de conta (`zpfy_acct_...`) — gerencia instâncias e webhooks.
    instanceToken:
      type: http
      scheme: bearer
      description: Token de instância (`zpfy_inst_...`) — envia mensagens.

````