GET List instances

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.

​

Endpoint

GET /api/v1/instances

​

Authentication

​

Parameters

​

Request example

curl https://srv.msgflash.com/api/v1/instances \
  -H "x-api-key: msgf_live_your_api_key_here"

​

Success response 200

{
  "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"
    }
  ]
}

​

How to get the correct instanceId

1. Call GET /api/v1/instances.
2. Choose an instance with status = "connected".
3. Copy data[n].id.
4. Use this value as instanceId in:
   • POST /api/v1/messages/send
   • POST /api/v1/messages/schedule
   • POST /api/v1/campaigns

​

Common errors