ByDomuDevelopers
Criar chave

Listar etiquetas

GEThttps://api.bydomu.com/v1/tags

Esta referência é gerada a partir do código da API, por isso as descrições estão em espanhol. Nomes, parâmetros e exemplos são iguais em qualquer idioma.

Etiquetas de la organización en orden alfabético, con cuántos contactos, negocios, conversaciones y propiedades usan cada una.

Permissão
tags:read
Chaves
Só secreta (de um servidor)

Cabeçalhos

X-API-Keystringobrigatório
Sua chave secreta.

Respostas

200Etiquetas
401UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.
403FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.
429RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.
500INTERNAL_ERROR · Error interno del servidor.
cURL
curl "https://api.bydomu.com/v1/tags" \
  -H "X-API-Key: $BYDOMU_API_KEY"
JavaScript
const res = await fetch("https://api.bydomu.com/v1/tags", {
  headers: { "X-API-Key": process.env.BYDOMU_API_KEY },
});
const data = await res.json();
Python
import os, requests

r = requests.get(
    "https://api.bydomu.com/v1/tags",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()
Resposta · 200 · exemplo
{
  "data": [
    {
      "id": "clx1tag001",
      "name": "VIP",
      "color": "#F59E0B",
      "organizationId": "clx1org001",
      "_count": {
        "contacts": 18,
        "deals": 4,
        "conversations": 2,
        "properties": 0
      }
    }
  ]
}

A chave vai na variável BYDOMU_API_KEY. Os dados do exemplo não são de nenhuma imobiliária.