Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
business
/
available-categories
List categories
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/business/available-categories \
  --header 'Client-Token: <api-key>'
{
  "displayName": "<string>",
  "label": "<string>",
  "id": "<string>"
}

Overview

This method is responsible for listing all available categories for configuration on the WhatsApp Business profile.

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

query
string
Search by category

Response

200

displayName
string
Category display name
label
string
Category label
id
string
Category ID
[
  {
    "displayName": "Outras empresas",
    "label": "OTHER_COMPANIES",
    "id": "629412378414563"
  }
]

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”.