ByDomuDevelopers
Crear clave

Página de agendamiento de un agente

GEThttps://api.bydomu.com/v1/booking/{slug}/page

Configuración de la página (duración de los espacios, anticipación, color, mensajes) con el agente y la organización. OJO: la respuesta viene doblemente envuelta, { data: { data: ... } }. Solo páginas de la organización de la clave (otro slug → 404).

Permiso
portal:read
Claves
Publicable o secreta

Encabezados

X-API-Keystringobligatorio
Tu clave publicable o secreta.

Parámetros de ruta

slugstringobligatorio
Slug de la página de agendamiento del agente

Respuestas

200La página de agendamiento
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/booking/carlos-rodriguez/page" \
  -H "X-API-Key: $BYDOMU_API_KEY"
JavaScript
const res = await fetch("https://api.bydomu.com/v1/booking/carlos-rodriguez/page", {
  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/booking/carlos-rodriguez/page",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()
Respuesta · 200 · ejemplo
{
  "data": {
    "data": {
      "id": "clx1bkp001",
      "slug": "carlos-rodriguez",
      "isActive": true,
      "title": "Agenda una visita con Carlos",
      "welcomeMessage": "Elige el día y la hora que te queden mejor.",
      "brandColor": "#0F766E",
      "slotDurationMinutes": 60,
      "bufferMinutes": 15,
      "maxDaysAhead": 30,
      "minNoticeHours": 12,
      "timeZone": "America/Bogota",
      "requireEmail": false,
      "requirePhone": true,
      "showProperties": true,
      "autoConfirm": false,
      "thankYouMessage": "¡Listo! Te confirmamos por WhatsApp.",
      "defaultType": "SHOWING",
      "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]"
      },
      "organization": {
        "id": "clx1org001",
        "name": "Inmobiliaria Andes",
        "slug": "inmobiliaria-andes",
        "logo": "https://cdn.bydomu.com/logos/andes.png",
        "phone": "+576015551234",
        "email": "[email protected]",
        "website": "https://inmobiliariaandes.co"
      }
    }
  }
}

La clave va en la variable BYDOMU_API_KEY. Los datos del ejemplo no son de ninguna inmobiliaria.