Skip to main content
GET
/
label
/
findLabels
/
:instanceName
curl --request GET \
  --url https://api.example.com/label/findLabels/my-instance \
  --header 'apikey: YOUR_API_KEY'

{
  "labels": [
    {
      "id": "1",
      "name": "New Customer",
      "color": "#00A0DC",
      "predefinedId": "1"
    },
    {
      "id": "2",
      "name": "Pending Payment",
      "color": "#F39C12",
      "predefinedId": "2"
    },
    {
      "id": "custom_123",
      "name": "VIP Client",
      "color": "#9B59B6",
      "predefinedId": null
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/EvolutionAPI/evolution-api/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

You can fetch all labels (tags) configured in your WhatsApp Business account. Labels help you organize and categorize chats and contacts.
Labels are only available for WhatsApp Business accounts. Regular WhatsApp accounts do not support labels.

​
Authentication

This endpoint requires authentication via the apikey header.
​
header.apikey
string
required
Your Evolution API key for authentication.

​
Path Parameters

​
path.instanceName
string
required
The name of your WhatsApp Business instance.

​
Response

​
labels
array
Array of label objects.
curl --request GET \
  --url https://api.example.com/label/findLabels/my-instance \
  --header 'apikey: YOUR_API_KEY'

{
  "labels": [
    {
      "id": "1",
      "name": "New Customer",
      "color": "#00A0DC",
      "predefinedId": "1"
    },
    {
      "id": "2",
      "name": "Pending Payment",
      "color": "#F39C12",
      "predefinedId": "2"
    },
    {
      "id": "custom_123",
      "name": "VIP Client",
      "color": "#9B59B6",
      "predefinedId": null
    }
  ]
}

​
Label Colors

WhatsApp Business provides predefined label colors:
  • Blue: #00A0DC
  • Orange: #F39C12
  • Purple: #9B59B6
  • Green: #16A085
  • Red: #E74C3C
  • Gray: #95A5A6

​
Usage Notes

WhatsApp Business allows you to create custom labels in addition to the predefined ones.
Use labels to organize chats by customer status, priority, or any other category relevant to your business.
Label management (creating, editing, deleting) is typically done through the WhatsApp Business app. This API allows you to fetch and assign existing labels.

Build docs developers (and LLMs) love

Get started for freeTalk to us