Skip to main content
TypeScript

Authorizations

Authorization
string
header
required

Your Periskope API token, sent as Authorization: Bearer <token>. Generate one from the Periskope dashboard under Settings → API & Webhooks. API access requires an active Pro or Enterprise plan.

Headers

x-phone
string
required

Phone to act with: country code + number without symbols or spaces (e.g. 911111111111), or a phone_id (phone-xxxxxxxxxxxx). The phone must be connected to the org and accessible by the API token.

Minimum string length: 1
Example:

"919876543210"

Response

HTML page with the QR code as an inline base64 PNG image

HTML snippet containing the QR code as an inline base64 PNG image. Open it in a browser and scan it with WhatsApp (Settings > Linked Devices) to connect.

Example:

"<img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...\" />"