API/Instâncias/Listar instâncias

Listar instâncias

Retorna uma lista de todas as instâncias criadas na API.

GET/instance/list

Response

200Lista de instâncias retornada com sucesso

Campo	Tipo	Descrição
`success`	boolean	Indica se a operação foi bem-sucedida
`data.instances`	array	Array de instâncias
`data.instances[].id`	UUID	ID único da instância
`data.instances[].name`	string	Nome da instância
`data.instances[].status`	string	Status da conexão (disconnected, connecting, qrcode, connected, error)

200 - application/json

{
  "success": true,
  "data": {
    "instances": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "minha-instancia",
        "status": "connected",
        "created_at": "2024-01-15T10:30:00.000Z"
      },
      {
        "id": "660e8400-e29b-41d4-a716-446655440001",
        "name": "outra-instancia",
        "status": "disconnected",
        "created_at": "2024-01-16T11:00:00.000Z"
      }
    ]
  }
}

GET/instance/list

Retorna uma lista de todas as instâncias criadas na API.

Example Response

200

{
  "success": true,
  "data": {
    "instances": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "minha-instancia",
        "status": "connected",
        "created_at": "2024-01-15T10:30:00.000Z"
      }
    ]
  }
}