ByDomuDevelopers
Create key

Listar campos personalizados de contactos

GEThttps://api.bydomu.com/v1/custom-fields

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

Definiciones activas de campos personalizados de CONTACTOS, ordenadas por sección y orden.

Permission
custom_fields:read
Keys
Secret only (server-side)

Headers

X-API-Keystringrequired
Your secret key.

Responses

200Campos personalizados
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/custom-fields" \
  -H "X-API-Key: $BYDOMU_API_KEY"
JavaScript
const res = await fetch("https://api.bydomu.com/v1/custom-fields", {
  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/custom-fields",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()
Response · 200 · example
{
  "data": [
    {
      "id": "clx1cf001",
      "name": "tipo_credito",
      "label": "Tipo de crédito",
      "fieldType": "TEXT",
      "options": [
        "Hipotecario"
      ],
      "section": "financiero",
      "entity": "CONTACT",
      "isRequired": false,
      "order": 1,
      "isActive": true,
      "placeholder": "Selecciona el tipo de crédito",
      "helpText": "Financiación aprobada del cliente",
      "createdAt": "2025-06-01T10:00:00.000Z",
      "updatedAt": "2026-01-15T14:00:00.000Z"
    }
  ]
}

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