Get Client WhatsApp Business Accounts
Retrieve a list of WhatsApp Business Accounts that have been shared with the specified business.
Use Cases:
- Monitor shared WABA relationships and permissions
- Verify WABA configuration and status information
- Retrieve WABA details for business integrations
- Manage multi-business WhatsApp messaging setups
Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff.
Caching: WABA information can be cached for moderate periods, but status information may change frequently. Implement appropriate cache invalidation strategies.
Request
- Base URLhttps://graph.facebook.com
- URLhttps://graph.facebook.com/{Version}/{Business-ID}/client_whatsapp_business_accounts
- AuthHTTP bearer
Path parameters
Graph API version to use for this request. Determines the API behavior and available features.
Your Business ID. This ID can be found in your Meta Business Suite URL or through business management APIs.
Query parameters
Comma-separated list of fields to include in the response. If not specified, default fields will be returned (id, name, currency, timezone_id). Available fields: id, name, account_review_status, purchase_order_number, audiences, ownership_type, subscribed_apps, business_verification_status, country, currency, timezone_id, on_behalf_of_business_info, schedules, is_enabled_for_insights, dcc_config, message_templates, phone_numbers
Filter results by WhatsApp Business Account type
Maximum number of WhatsApp Business Accounts to return per page. Default is 25, maximum is 100.
Cursor for pagination. Use this to get the next page of results.
Cursor for pagination. Use this to get the previous page of results.
Find a specific WhatsApp Business Account by ID
Headers
The user agent string identifying the client software making the request.
Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.
Response
Successfully retrieved client WhatsApp Business Accounts
Example response
{
"data": [
{
"id": "1234567890123456",
"name": "My WhatsApp Business Account",
"account_review_status": "APPROVED",
"purchase_order_number": "PO-2023-001234",
"audiences": [
"customers",
"prospects"
],
"ownership_type": "CLIENT_OWNED",
"subscribed_apps": [
{
"id": "9876543210987654",
"name": "WhatsApp Integration App"
}
],
"business_verification_status": "VERIFIED",
"country": "US",
"currency": "USD",
"timezone_id": "1",
"on_behalf_of_business_info": {
"id": "5678901234567890",
"name": "Partner Business Inc"
},
"schedules": [
{
"day_of_week": "MONDAY",
"open_time": "09:00",
"close_time": "17:00"
}
],
"is_enabled_for_insights": true,
"dcc_config": {
"enabled": true,
"policy_url": "https://example.com/dcc-policy"
},
"message_templates": [
{
"id": "template_123456",
"name": "welcome_message",
"status": "APPROVED"
}
],
"phone_numbers": [
{
"id": "1234567890123456",
"display_phone_number": "+1 (555) 123-4567",
"verified_name": "Example Business"
}
]
}
],
"paging": {
"cursors": {
"before": "QVFIUjNpUWpVWmRBd0dn",
"after": "QVFIUjNpUWpVWmRBd0Rn"
},
"previous": "https://graph.facebook.com/v23.0/1234567890/connected_client_businesses?before=QVFIUjNpUWpVWmRBd0Dn",
"next": "https://graph.facebook.com/v23.0/1234567890/connected_client_businesses?after=QVFIUjNpUWpVWmRBd0Rn"
}
}Changes
No recorded changes to this operation across all 5 revisions of this API.