GET /business/{jid}/profile

Get the business profile of a WhatsApp Business account including description, category, website, email, and address.

Path parameters

  • jid string Required

    JID of the business account

Responses

  • 200 application/json

    Business profile retrieved successfully

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • data object
      Hide data attributes Show data attributes object
      • jid string
      • description string
      • category string
      • website array[string]
      • email string
      • address string
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • error string
  • 404 application/json

    Business not found

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • error string
  • 500 application/json

    Internal server error

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • error string
GET /business/{jid}/profile
curl \
 --request GET 'http://localhost:7001/business/6281234567890@s.whatsapp.net/profile' \
 --header "Authorization: $API_KEY"
Response examples (200)
{
  "code": 200,
  "data": {
    "jid": "6281234567890@s.whatsapp.net",
    "email": "contact@example.com",
    "address": "123 Business Street, Jakarta, Indonesia",
    "website": [
      "https://example.com",
      "https://support.example.com"
    ],
    "category": "Technology",
    "description": "Your trusted business partner for all technology needs"
  },
  "status": true,
  "message": "Business profile retrieved successfully"
}
Response examples (200)
{
  "status": true,
  "code": 200,
  "message": "Business profile retrieved successfully",
  "data": {
    "jid": "6281234567890@s.whatsapp.net",
    "description": "Your trusted business partner",
    "category": "Technology",
    "website": [
      "https://example.com"
    ],
    "email": "contact@example.com",
    "address": "123 Business Street, City"
  }
}
Response examples (401)
{
  "code": 401,
  "error": "Invalid or expired JWT token",
  "status": false,
  "message": "Unauthorized"
}
Response examples (401)
{
  "status": false,
  "code": 401,
  "message": "Unauthorized",
  "error": "Invalid or missing authentication"
}
Response examples (404)
{
  "code": 404,
  "error": "Business profile not found or not a business account",
  "status": false,
  "message": "Not found"
}
Response examples (404)
{
  "status": false,
  "code": 404,
  "message": "Not found",
  "error": "Resource not found"
}
Response examples (500)
{
  "code": 500,
  "error": "Failed to retrieve business profile",
  "status": false,
  "message": "Internal server error"
}
Response examples (500)
{
  "status": false,
  "code": 400,
  "message": "Bad request",
  "error": "Bad request"
}