Get a WhatsApp setup link
Returns a setup link’s status and connection details. Request: GET /v1/whatsapp/setup-links/{linkId}. Scope: whatsappAccounts:read.
GET
Returns a setup link’s status and connection details.
apiKeyheader
x-api-key<token>linkId*stringMatch
^wasl_[0-9a-hjkmnp-tv-z]{16,24}$WhatsAppSetupLink
application/json- response
id*WhatsAppSetupLinkIdMatch
^wasl_[0-9a-hjkmnp-tv-z]{16,24}$organizationId*OrganizationIdMatch
^org_[0-9a-hjkmnp-tv-z]{16,24}$namespaceId*NamespaceIdMatch
^ns_[0-9a-hjkmnp-tv-z]{16,24}$status*WhatsAppSetupLinkStatusValue in
"pending""completed""revoked""expired"redirectUrl*string|nullmetadata*expiresAt*stringbusinessAccountId*|nullcompletedAt*string|nullrevokedAt*string|nullcreatedAt*stringupdatedAt*stringimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.whatsappSetupLinks.get({
"linkId": "example"
});Example Response
{
"id": "string",
"organizationId": "string",
"namespaceId": "string",
"status": "pending",
"redirectUrl": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"expiresAt": "string",
"businessAccountId": "string",
"completedAt": "string",
"revokedAt": "string",
"createdAt": "string",
"updatedAt": "string"
}