Skip to content
ONPADDocs

Docs / API

Check status

GET /v1/status — verify your API key and see the workspace and WhatsApp connection it belongs to.

View as Markdown

Confirms an API key works and reports the workspace and WhatsApp connection behind it. The cheapest way to test an integration before sending anything.

GET https://app.onpad.in/api/v1/status

Example

curl https://app.onpad.in/api/v1/status \
  -H "Authorization: Bearer wh_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

{
  "ok": true,
  "workspace": {
    "id": 128,
    "name": "Sunrise Store",
    "slug": "sunrise-store",
    "country": "India",
    "timezone": "Asia/Kolkata"
  },
  "whatsapp": {
    "status": "connected",
    "phone_number": "919876543210",
    "verified_name": "Sunrise Store"
  },
  "server_time": "2026-10-04T09:21:33+05:30"
}

Fields

FieldDescription
workspace.idNumeric workspace id
workspace.nameThe workspace name
workspace.slugURL-safe version of the name
workspace.country, workspace.timezoneUsed for scheduling and formatting
whatsapp.statusconnected, not_started, pending or error
whatsapp.phone_numberThe connected number, digits only
whatsapp.verified_nameThe display name Meta approved
server_timeOur clock, ISO 8601 — useful for checking clock drift on your side

Status codes

CodeMeaning
200The key is valid
401invalid_api_key — bad, revoked, or the plan does not include API access

Use it for

A deploy check. Call it after deploying an integration. A 200 with whatsapp.status: "connected" means sending will work.

Diagnosing a 401. If /status also returns 401, the problem is the key or the plan — not the message you were trying to send.

Checking the connection before a batch. whatsapp.status other than connected means every send will fail. Check once rather than discovering it a thousand failures later.

This endpoint does not send anything and costs nothing.

Still stuck?

Ask ONPAD, the assistant inside your workspace, can answer questions about your own data — how a specific campaign performed, why one message failed, what your limits are right now.

Ask ONPAD in your workspaceEmail support@onpad.in