Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Admin API key (format: sk_admin_*) for organization-level operations

Path Parameters

sessionId
string
required

WhatsApp Signup Session ID

Pattern: ^wss_[a-zA-Z0-9]+$
Example:

"wss_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Response

Session details

id
string
required

WhatsApp Signup Session ID

Pattern: ^wss_[a-zA-Z0-9]+$
Example:

"wss_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

status
enum<string>
required

Session status

Available options:
pending,
completed,
recovered,
cancelled,
failed,
expired
Example:

"pending"

metaWabaId
string | null
required

Meta's WhatsApp Business Account ID (set when completed or recovered)

businessProfileId
string | null
required

The created WhatsApp Business Profile ID (set when completed)

expiresAt
string<date-time>
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
metadata
object

Developer-provided metadata for filtering sessions by internal user IDs. Useful for platforms with multiple end-users. Maximum size: 10KB.

Example: