Listar campos personalizados de contactos

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

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.

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

Permissão
custom_fields:read
Chaves
Só secreta (de um servidor)

Cabeçalhos

X-API-Keystringobrigatório
Sua chave secreta.

Respostas

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()
Resposta · 200 · exemplo
{
  "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"
    }
  ]
}

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