> ## 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.

# Connection status

> Returns whether the instance is connected and logged in to WhatsApp.



## OpenAPI

````yaml /en/api-reference/openapi.json get /instance/status
openapi: 3.1.0
info:
  title: Zapfy API
  description: >-
    Multi-tenant WhatsApp API. Send messages and manage webhooks through a
    single surface.
  version: 1.0.0
servers:
  - url: https://api.zapfy.io/v1
security:
  - accountToken: []
paths:
  /instance/status:
    get:
      tags:
        - Instance
      summary: Connection status
      description: Returns whether the instance is connected and logged in to WhatsApp.
      responses:
        '200':
          $ref: '#/components/responses/ConnectionStatus'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '502':
          $ref: '#/components/responses/Error'
      security:
        - instanceToken: []
components:
  responses:
    ConnectionStatus:
      description: Connection status.
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                $ref: '#/components/schemas/ConnectionStatusResult'
    Error:
      description: Error.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Instance not found
  schemas:
    ConnectionStatusResult:
      type: object
      properties:
        connected:
          type: boolean
          description: Whether the instance is connected to WhatsApp.
          example: true
        loggedIn:
          type: boolean
          description: Whether the WhatsApp session is authenticated.
          example: true
        name:
          type: string
          description: Name of the connected profile.
          example: Minha Loja
  securitySchemes:
    accountToken:
      type: http
      scheme: bearer
      description: Account token (`zpfy_acct_...`) — manages instances and webhooks.
    instanceToken:
      type: http
      scheme: bearer
      description: Instance token (`zpfy_inst_...`) — sends messages.

````