ByDomuDevelopers
Criar chave

Listar agentes

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

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.

Miembros de la organización con al menos una propiedad publicada en el portal, ordenados por cantidad de propiedades (de más a menos).

Permissão
portal:read
Chaves
Publicável ou secreta

Cabeçalhos

X-API-Keystringobrigatório
Sua chave publicável ou secreta.

Respostas

200Agentes con propiedades publicadas
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/agents" \
  -H "X-API-Key: $BYDOMU_API_KEY"
JavaScript
const res = await fetch("https://api.bydomu.com/v1/agents", {
  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/agents",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()
Resposta · 200 · exemplo
{
  "data": [
    {
      "id": "clx1usr001",
      "firstName": "Carlos",
      "lastName": "Rodríguez",
      "avatarUrl": "https://cdn.bydomu.com/avatars/carlos.jpg",
      "bio": "Asesor con 10 años en el mercado de Bogotá.",
      "phone": "+573001234567",
      "email": "[email protected]",
      "propertyCount": 12
    }
  ]
}

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