Get Business Profile Information

GET /user/business-profile

Basic auth

Retrieve detailed business profile information for a WhatsApp business account

Query parameters

phone string Required

Phone number with country code of the business account

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- code string
- message string
- results object
  
  Hide results attributes Show results attributes object
  
  jid string
  
  Business account JID
  
  email string
  
  Business email address
  
  address string
  
  Business physical address
  
  categories array[object]
  
  Business categories
  
  Hide categories attributes Show categories attributes object
  
  id string
  
  name string
  
  profile_options object
  
  Additional profile options
  
  business_hours_timezone string
  
  Business hours timezone
  
  business_hours array[object]
  
  Business operating hours
  
  Hide business_hours attributes Show business_hours attributes object
  
  day_of_week string
  
  mode string
  
  open_time string
  
  close_time string
400 application/json

Bad Request
Hide response attributes Show response attributes object
- code string
  
  HTTP Status Code
- message string
  
  Detail error message
- results object
  
  additional data
500 application/json

Internal Server Error
Hide response attributes Show response attributes object
- code string
  
  SYSTEM_CODE_ERROR
- message string
  
  Detail error message
- results object
  
  additional data

GET /user/business-profile

curl \
 --request GET 'http://localhost:3000/user/business-profile?phone=6289685028129%40s.whatsapp.net' \
 --user "username:password"

Response examples (200)

{
  "code": "SUCCESS",
  "message": "Success get business profile",
  "results": {
    "jid": "6289685028129@s.whatsapp.net",
    "email": "business@example.com",
    "address": "123 Business Street, City, Country",
    "categories": [
      {
        "id": "retail",
        "name": "Retail Store"
      }
    ],
    "profile_options": {
      "website": "https://example.com",
      "description": "Business description"
    },
    "business_hours_timezone": "Asia/Jakarta",
    "business_hours": [
      {
        "day_of_week": "monday",
        "mode": "open",
        "open_time": "09:00",
        "close_time": "18:00"
      }
    ]
  }
}

Response examples (400)

{
  "code": 400,
  "message": "field cannot be blank",
  "results": {}
}

Response examples (500)

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "you are not loggin",
  "results": {}
}