Skip to main content
GET
/
api
/
{session}
/
labels
Obter todas as etiquetas
curl --request GET \
  --url https://{host}/api/{session}/labels \
  --header 'apikey: <api-key>'
{
  "labels": [
    {
      "id": "label123",
      "name": "Clientes VIP",
      "color": 1
    },
    {
      "id": "label456",
      "name": "Suporte",
      "color": 2
    }
  ]
}

​
Descrição

Este endpoint retorna todos os rótulos (labels) criados na sessão WhatsApp, permitindo visualizar todas as categorias disponíveis para organização de chats.

​
Parâmetros de URL

​
session
string
required
ID único da sessão WhatsApp

​
Resposta

​
labels
array
Lista de todos os rótulos criados
{
  "labels": [
    {
      "id": "label123",
      "name": "Clientes VIP",
      "color": 1
    },
    {
      "id": "label456",
      "name": "Suporte",
      "color": 2
    }
  ]
}

​
Códigos de Status

  • 200 - Lista retornada com sucesso
  • 400 - Parâmetros inválidos
  • 401 - Não autorizado

​
Exemplo de Uso

curl -X GET https://api.wappfy.com.br/api/my-session/labels

Authorizations

​
apikey
string
header
required

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Path Parameters

​
session
string
required

Nome da sessão (instanceName)

Response

200 - application/json
​
id
string
required

Label ID

Example:

"1"

​
name
string
required

Label name

Example:

"Lead"

​
color
number
required

Color number, not hex

Example:

0

​
colorHex
string
required

Color in hex

Example:

"#ff9485"

⌘I