Skip to main content
GET
/
v1
/
organization
/
embedded-signup
/
sessions
/
{sessionId}
cURL
curl --request GET \
  --url https://api.buildwithchirp.com/v1/organization/embedded-signup/sessions/{sessionId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "wss_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "status": "pending",
  "metaWabaId": "<string>",
  "businessProfileId": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "metadata": {
    "externalUserId": "user_123",
    "businessName": "Acme Corp"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.buildwithchirp.com/llms.txt

Use this file to discover all available pages before exploring further.

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:
{
  "externalUserId": "user_123",
  "businessName": "Acme Corp"
}