Skip to Content

List WhatsApp business accounts

Returns a paginated list of the organization's connected WhatsApp business accounts.

GET
/v1/whatsapp/business-accounts

Returns a paginated list of the organization's connected WhatsApp business accounts.

Authorization

apiKey
headerx-api-key<token>

Query Parameters

page?|null
limit?|null
isActive?boolean|null
verificationStatus?string
Value in"pending""verified""failed""suspended"
namespaceId?string
Match^ns_[0-9a-hjkmnp-tv-z]{16,24}$

Response Body

Success

application/json
  1. response
items*array<>
pagination*
Example Request
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
  }
}

Related documentation