> ## Documentation Index
> Fetch the complete documentation index at: https://www.ayrshare.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# WhatsApp Business Profile

> Get the current WhatsApp business profile for the linked WhatsApp account

Get the current WhatsApp business profile for the linked WhatsApp account: `about`, `description`, `address`, `email`, `websites`, `vertical`, and the profile picture URL (returned as `profile_picture_url`).

> [!NOTE]
>
> **WhatsApp is in Private Beta.** Reading a WhatsApp business profile requires an account
> approved for WhatsApp. If you'd like early access, email
> [lotty@ayrshare.com](mailto:lotty@ayrshare.com).

A field you have never set is omitted from `data` rather than returned as an empty value. If the WhatsApp Business Account has no profile configured yet, `data` is an empty object.

To change these fields, see [Update User](/docs/apis/user/update-user).

## Header Parameters

**Authorization** `string` *required*

[API Key](/docs/apis/overview#authorization) of the Primary Profile.

Format: `Authorization: Bearer API_KEY`
**Profile-Key** `string`

[Profile Key](/docs/apis/overview#profile-key-format) of a User Profile.

Format: `Profile-Key: PROFILE_KEY`

```bash cURL theme={"system"}
curl \
-H "Authorization: Bearer API_KEY" \
-X GET https://api.ayrshare.com/api/user/details/whatsapp
```

```javascript JavaScript theme={"system"}
const API_KEY = "API_KEY";

fetch("https://api.ayrshare.com/api/user/details/whatsapp", {
      method: "GET",
      headers: {
        "Authorization": `Bearer ${API_KEY}`
      }
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);
```

```python Python theme={"system"}
import requests

headers = {'Authorization': 'Bearer API_KEY'}

r = requests.get('https://api.ayrshare.com/api/user/details/whatsapp', headers=headers)

print(r.json())
```

```php PHP theme={"system"}
<?php

$apiUrl = 'https://api.ayrshare.com/api/user/details/whatsapp';
$apiKey = 'API_KEY';  // Replace 'API_KEY' with your actual API key

$headers = [
    'Content-Type: application/json',
    'Authorization: Bearer ' . $apiKey,
];

$curl = curl_init($apiUrl);
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => $headers
]);

$response = curl_exec($curl);

if ($response === false) {
    echo 'Curl error: ' . curl_error($curl);
} else {
    echo json_encode(json_decode($response), JSON_PRETTY_PRINT);
}

curl_close($curl);

```

```csharp C# theme={"system"}
using System;
using System.Net.Http;
using System.Threading.Tasks;

namespace WhatsAppProfileGETRequest_csharp
{
class WhatsAppProfile
{
    static async Task Main(string[] args)
    {
        string API_KEY = "API_KEY";
        string url = "https://api.ayrshare.com/api/user/details/whatsapp";

        using (var client = new HttpClient())
        {
            client.DefaultRequestHeaders.Add("Authorization", "Bearer " + API_KEY);
            
            try
            {
                HttpResponseMessage response = await client.GetAsync(url);
                response.EnsureSuccessStatusCode();
                string responseBody = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseBody);
            }
            catch (HttpRequestException e)
            {
                Console.WriteLine($"Error: {e.Message}");
            }
        }
    }
}
}
```

```json 200: Success theme={"system"}
{
  "whatsapp": {
    "status": "success",
    "data": {
      "messaging_product": "whatsapp",
      "about": "Open 9am-6pm",
      "description": "Bike shop since 1998",
      "address": "123 Example St, Springfield",
      "email": "hello@example.com",
      "websites": ["https://example.com"],
      "vertical": "RETAIL",
      "profile_picture_url": "https://scontent.whatsapp.net/..."
    }
  }
}
```

```json 200: No Profile Configured theme={"system"}
{
  "whatsapp": {
    "status": "success",
    "data": {}
  }
}
```

```json 400: WhatsApp Not Linked theme={"system"}
{
  "action": "get",
  "status": "error",
  "code": 103,
  "message": "Missing social account. Please link the social account and try again."
}
```

```json 400: Missing or Incorrect Parameters theme={"system"}
{
  "action": "request",
  "status": "error",
  "code": 101,
  "message": "Missing or incorrect parameters. Please verify with the docs. https://www.ayrshare.com/docs/apis",
  "details": "Meta rejected the WhatsApp profile request."
}
```

```json 429: Too Many Requests theme={"system"}
{
  "action": "rate limit",
  "status": "error",
  "code": 364,
  "message": "You are making too many requests. Please reduce the number of requests.",
  "details": "Meta rejected the WhatsApp profile request."
}
```

```json 500: Connection Issue theme={"system"}
{
  "action": "authorization",
  "status": "error",
  "code": 141,
  "message": "There was an issue connecting. Please try linking the social account again.",
  "details": "Network error fetching the WhatsApp business profile."
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.