---
title: "Connect an instance (get QR code)"
method: GET
path: "/v1/instance/connect/{id}"
tags: ["Instance"]
---

# Connect an instance (get QR code)

`GET /v1/instance/connect/{id}`

## Request

- Base URL: `http://localhost:8080`
- URL: `http://localhost:8080/v1/instance/connect/{id}`
- Auth: API key in header `apikey`

Initiates connection for an instance. Returns a base64-encoded QR code PNG if not yet connected, or a connected status message. While QR generation or a saved session reconnection is pending, returns 200 with connected=false and no base64. Saved sessions are preserved during reconnection.

## Path parameters

- `id` string, required

## Response `200`

OK

- DtoConnectInstanceResponse
  - `alwaysOnline` boolean
  - `base64` string
  - `connected` boolean
  - `groupsIgnore` boolean
  - `id` string
  - `message` string
  - `msgCall` string
  - `pairingCode` string
  - `pairingError` string
  - `proxyHost` string
  - `proxyPassword` string
  - `proxyPort` string
  - `proxyProtocol` string
  - `proxyUsername` string
  - `readMessages` boolean
  - `rejectCall` boolean
  - `remoteJID` string
  - `saveMedia` boolean
  - `syncFullHistory` boolean
  - `webhook` ModelsInstanceWebhook
    - `base64` boolean
    - `enabled` boolean
    - `events` string[]
    - `headers` object
    - `url` string

## Other responses

- `401`: Unauthorized
- `404`: Not Found
- `422`: Unprocessable Entity
- `500`: Internal Server Error

## Changes

- **2026-07-18** `f812473c5a89`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/verbeux-ai/apis/whatsmiau-api/changes/v1/instance/connect/:id/get.md)

---

[API](https://skmtc.dev/verbeux-ai/apis/whatsmiau-api.md) - [All operations](https://skmtc.dev/verbeux-ai/apis/whatsmiau-api/llms.txt) - [OpenAPI document](https://skmtc.dev/verbeux-ai/apis/whatsmiau-api/revisions/b425ec589eb0?raw)