ByDomuDevelopers
Create key

Configuración del portal

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

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

Devuelve la configuración del portal principal de la organización: plantilla, tema, secciones visibles y configuración del buscador. Si la organización aún no tiene portal responde valores por defecto con isEnabled: false.

Permission
portal:read
Keys
Publishable or secret

Headers

X-API-Keystringrequired
Your publishable or secret key.

Responses

200Configuración del portal
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/portal" \
  -H "X-API-Key: $BYDOMU_API_KEY"
JavaScript
const res = await fetch("https://api.bydomu.com/v1/portal", {
  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/portal",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()
Response · 200 · example
{
  "data": {
    "id": "clx1por001",
    "isEnabled": true,
    "slug": "inmobiliaria-andes",
    "isDefault": true,
    "kind": "MANAGED",
    "themePublished": {
      "primaryColor": "#0F766E"
    },
    "logoUrl": "https://cdn.bydomu.com/logos/andes.png",
    "faviconUrl": "https://cdn.bydomu.com/logos/andes-favicon.png",
    "coverImageUrl": "https://cdn.bydomu.com/covers/andes.jpg",
    "contactEmail": "[email protected]",
    "contactPhone": "+576015551234",
    "contactWhatsapp": "+573001234567",
    "contactAddress": "Cra 7 #45-12, Bogotá",
    "facebookUrl": "https://facebook.com/inmobiliariaandes",
    "instagramUrl": "https://instagram.com/inmobiliariaandes",
    "customDomain": "www.inmobiliariaandes.co",
    "customDomainVerified": true,
    "publishedAt": "2026-06-01T12:00:00.000Z",
    "createdAt": "2026-01-10T15:00:00.000Z",
    "updatedAt": "2026-09-01T09:30:00.000Z"
  }
}

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