Skip to main content
GET
/
api
/
sessions
/
{session}
Get session information
curl --request GET \
  --url https://{host}/api/sessions/{session} \
  --header 'apikey: <api-key>'
{
  "session": "my-session",
  "status": "authenticated",
  "authenticated": true,
  "config": {
    "store": {
      "dialect": "sqlite3",
      "address": "/app/data/whatsmeow.db"
    },
    "log": {
      "level": "INFO"
    }
  }
}

​
Description

This endpoint returns detailed information about a specific session, including its current status (active, paused, authenticated, etc.) and configurations.

​
URL Parameters

​
session
string
required
Unique session ID to be queried

​
Response

​
session
string
required
ID of the session
​
status
string
required
Current status of the session: “active”, “stopped”, “disconnected”, “authenticated”
​
authenticated
boolean
required
Indicates if the session is authenticated on WhatsApp
​
config
object
Session configurations (if available)
{
  "session": "my-session",
  "status": "authenticated",
  "authenticated": true,
  "config": {
    "store": {
      "dialect": "sqlite3",
      "address": "/app/data/whatsmeow.db"
    },
    "log": {
      "level": "INFO"
    }
  }
}

​
Status Codes

  • 200 - Information obtained successfully
  • 400 - Invalid parameters
  • 404 - Session not found

​
Usage Example

curl -X GET https://api.wappfy.com.br/api/sessions/my-session

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Path Parameters

​
session
string
required

The session name (instanceName) you want to query

Response

200 - application/json
​
name
string
required

Session instance name. Use 'session' as default value

Example:

"default"

​
status
enum<string>
required
Available options:
STOPPED,
STARTING,
SCAN_QR_CODE,
WORKING,
FAILED
​
me
object
​
assignedWorker
string
​
config
object
⌘I