List WhatsApp business accounts
Returns a paginated list of the organization's connected WhatsApp business accounts.
GET
Returns a paginated list of the organization's connected WhatsApp business accounts.
apiKeyheader
x-api-key<token>page?|nulllimit?|nullisActive?boolean|nullverificationStatus?stringValue in
"pending""verified""failed""suspended"namespaceId?stringMatch
^ns_[0-9a-hjkmnp-tv-z]{16,24}$Success
application/json- response
items*array<>pagination*import { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.whatsapp.listBusinessAccounts({});Example Response
{
"items": [
{
"id": "string",
"organizationId": "string",
"namespaceId": "string",
"phoneNumber": "string",
"phoneNumberId": "string",
"displayName": "string",
"whatsappBusinessAccountId": "string",
"verificationStatus": "pending",
"credentialStatus": "active",
"tokenExpiresAt": "string",
"isDefault": true,
"webhookUrl": "string",
"qualityRating": "green",
"messagingLimit": "string",
"currentLimit": 0,
"businessPortfolioId": "string",
"businessAppConnectedAt": "string",
"businessAppDisconnectedAt": "string",
"businessAppDisconnectReason": "partnerRemoved",
"contactsSyncRequestedAt": "string",
"historySyncStatus": "requested",
"historySyncProgress": 0,
"isActive": true,
"createdAt": "string",
"updatedAt": "string"
}
],
"pagination": {
"page": 0,
"limit": 0,
"total": 0,
"totalPages": 0
}
}