---
title: "Fetch Instances"
method: GET
path: "/instance/fetchInstances"
tags: ["Instance Controller"]
---

# Fetch Instances

`GET /instance/fetchInstances`

## Request

- Base URL: `https://evolution-example`
- URL: `https://evolution-example/instance/fetchInstances`
- Auth: API key in header `apikey`

Returns the instance with the name informed in the parameter, or all the instances if empty.

## Query parameters

- `instanceName` string
- `instanceId` string

## Response `200`

Ok

- object
  - `status` integer: The HTTP status of the response
  - `error` string: The error message indicating the type of error
  - `response` object
    - `message` string[]: List of detailed error messages

## Changes

- **2024-11-25** (v2) `0184b7a57041`: 1 info
  - added the new optional `query` request parameter `instanceId`
- **2024-11-25** (v2) `c153448703e5`: 6 info
  - api operation id `fetchInstances` was added
  - the endpoint scheme security `ApiKeyAuth` was added to the API
  - the endpoint scheme security `apikeyAuth` was removed from the API
  - api tag `Instance Controller` added
  - …2 more
- **2024-09-09** (v2) `0c4620ca5ed5`: 1 warning, 5 info
  - deleted the `query` request parameter `instanceName`
  - api operation id `fetchInstances` removed and replaced with ``
  - the endpoint scheme security `apikeyAuth` was added to the API
  - the endpoint scheme security `ApiKeyAuth` was removed from the API
  - …2 more

[Operation history](https://skmtc.dev/evolution-foundation/apis/evolution-api-3/changes/instance/fetchInstances/get.md)

---

[API](https://skmtc.dev/evolution-foundation/apis/evolution-api-3.md) - [All operations](https://skmtc.dev/evolution-foundation/apis/evolution-api-3/llms.txt) - [OpenAPI document](https://skmtc.dev/evolution-foundation/apis/evolution-api-3/revisions/153363ee7f38?raw)