ByDomuDevelopers
Create key

Perfil de agente

GEThttps://api.bydomu.com/v1/agents/{id}

This reference is generated from the API’s code, so descriptions are in Spanish. Names, parameters and examples are the same in every language.

Perfil de un miembro de la organización con sus propiedades publicadas en el portal.

Permission
portal:read
Keys
Publishable or secret

Headers

X-API-Keystringrequired
Your publishable or secret key.

Path parameters

idstringrequired
ID del usuario (agente)

Responses

200El agente y sus propiedades
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.
404NOT_FOUND · El recurso no existe en la organización.
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/clx1usr001" \
  -H "X-API-Key: $BYDOMU_API_KEY"
JavaScript
const res = await fetch("https://api.bydomu.com/v1/agents/clx1usr001", {
  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/clx1usr001",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()
Response · 200 · example
{
  "data": {
    "agent": {
      "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]"
    },
    "properties": [
      {
        "id": "clx1prop001",
        "code": "P-0042",
        "title": "Apartamento en Chapinero con vista",
        "description": "Apartamento de 85 m² con balcón y vista a los cerros.",
        "type": "APARTMENT",
        "transactionType": "SALE",
        "rentalServiceType": "BROKERAGE",
        "status": "DRAFT",
        "price": "450000000.00",
        "rentPrice": "3500000.00",
        "currency": "COP",
        "adminFee": "380000.00",
        "securityDeposit": "3500000.00",
        "neighborhood": "Chapinero",
        "city": "Bogotá",
        "state": "Cundinamarca",
        "country": "CO",
        "bedrooms": 3,
        "bathrooms": 2,
        "halfBathrooms": 1,
        "parkingSpots": 1,
        "area": 85,
        "builtArea": 80,
        "floor": 8,
        "stratum": 4,
        "yearBuilt": 2015,
        "elevator": true,
        "petFriendly": true,
        "furnished": "UNFURNISHED",
        "amenities": [
          "pool"
  …

The key goes in the BYDOMU_API_KEY variable. The example data belongs to no agency.