List Assigned Users
Retrieve a list of users assigned to the WhatsApp Business Account with their permissions and user details. This endpoint supports pagination and filtering capabilities.
Use Cases:
- Audit user access to WhatsApp Business Account
- Retrieve user permission assignments for compliance
- List all users with access for management purposes
- Monitor user access patterns and assignments
Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff.
Caching: User assignment data can be cached for short periods, but permission changes may occur frequently. Implement appropriate cache invalidation strategies.
Request
- Base URLhttps://graph.facebook.com
- URLhttps://graph.facebook.com/{Version}/{WhatsApp-Business-Account-ID}/assigned_users
- AuthHTTP bearer
Path parameters
Graph API version to use for this request. Determines the API behavior and available features.
Your WhatsApp Business Account ID. This ID is provided when you create the account and can be found in your Business Manager or through account management APIs.
Query parameters
Business ID that owns or has access to the WhatsApp Business Account. This parameter is required to specify the business context for user assignments.
Comma-separated list of fields to include in the response. If not specified, default fields will be returned (id, name). Available fields: id, name, business, user_type
Maximum number of assigned users 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.
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 assigned users list
Example response
{
"data": [
{
"id": "1234567890123456",
"name": "John Smith",
"business": {
"id": "9876543210987654",
"name": "Example Business Inc"
},
"user_type": "BUSINESS_USER"
}
],
"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"
},
"summary": {
"total_count": 25
}
}Changes
No recorded changes to this operation across all 5 revisions of this API.