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

# GET Retrieve an instance

> Retrieve instance details by ID.

## Endpoint

```txt theme={null}
GET /api/v1/instances/{id}
```

## Parameters path

| Nom  | Type | Required | Description      |
| ---- | ---- | -------- | ---------------- |
| `id` | UUID | yes      | ID de l'instance |

## Request example

```bash theme={null}
curl https://srv.msgflash.com/api/v1/instances/INSTANCE_ID \
  -H "x-api-key: msgf_live_your_api_key_here"
```

## Success response `200`

```json theme={null}
{
  "data": {
    "id": "inst_uuid",
    "name": "boutique-principale",
    "waNumber": "+33612345678",
    "status": "connected",
    "webhook": null,
    "meta": null,
    "deletedAt": null,
    "createdAt": "2026-04-01T09:00:00.000Z",
    "updatedAt": "2026-04-01T09:10:00.000Z"
  }
}
```

## Common errors

| HTTP  | Code           | When                                               |
| ----- | -------------- | -------------------------------------------------- |
| `401` | `UNAUTHORIZED` | API key missing or invalid                         |
| `404` | `NOT_FOUND`    | Instance does not exist or is outside your account |
