---
title: "List instances"
method: GET
path: "/instance/fetchInstances"
tags: ["Instance"]
---

# List instances

`GET /instance/fetchInstances`

Returns all instances, optionally filtered by name or ID

## Query parameters

- `instanceName` string
- `id` string

## Response `200`

OK

- DtoListInstancesResponse[]
  - `alwaysOnline` boolean
  - `groupsIgnore` boolean
  - `id` string
  - `instanceName` string
  - `msgCall` string
  - `ownerJid` string
  - `proxyHost` string
  - `proxyPassword` string
  - `proxyPort` string
  - `proxyProtocol` string
  - `proxyUsername` string
  - `readMessages` boolean
  - `readStatus` boolean
  - `rejectCall` boolean
  - `remoteJID` string
  - `syncFullHistory` boolean
  - `syncRecentHistory` boolean
  - `webhook` ModelsInstanceWebhook
    - `base64` boolean
    - `byEvents` boolean
    - `enabled` boolean
    - `events` string[]
    - `headers` object
    - `url` string

## Other responses

- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/verbeux-ai/apis/whatsmiau-api.md) · [All operations](https://skmtc.net/verbeux-ai/apis/whatsmiau-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/verbeux-ai/whatsmiau-api/versions/5af3cb49985a/schema)