Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
business
/
profile
Business account data
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/business/profile \
  --header 'Client-Token: <api-key>'
{
  "description": "<string>",
  "address": "<string>",
  "email": "<string>",
  "websites": [
    {}
  ],
  "categories": [
    {}
  ],
  "businessHours": {},
  "hasCoverPhoto": true
}

​
Overview

This method is responsible for returning the WhatsApp Business account profile data, including description, address, email, websites, categories, and business hours.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Query Parameters

​
phone
string
required
Business account phone number

​
Response

​
200

​
description
string
Company description
​
address
string
Company address
​
email
string
Company email
​
websites
array
Company websites
​
categories
array
Company categories
​
businessHours
object
Business hours
​
hasCoverPhoto
boolean
Indicates whether the account has a cover photo
{
  "description": "...",
  "address": "...",
  "email": "...",
  "websites": ["..."],
  "categories": [
    {
      "displayName": "...",
      "label": "...",
      "id": "..."
    }
  ],
  "businessHours": {
    "timezone": "America/Sao_Paulo",
    "days": [
      {
        "dayOfWeek": "MONDAY",
        "openTime": "08:00",
        "closeTime": "18:00"
      }
    ],
    "mode": "specificHours"
  },
  "hasCoverPhoto": false
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.