Recuperar layouts en Zoho CRM es sencillo una vez que sabes qué endpoints de la API utilizar — puedes obtener todos los layouts de un módulo o profundizar en un layout específico por su ID.
Por qué esto es importante
Los layouts en Zoho CRM controlan qué campos, secciones y reglas se presentan a los usuarios cuando crean o editan registros en un módulo determinado. Si estás creando una integración, automatizando la entrada de datos o auditando la configuración de tu CRM, necesitarás recuperar las definiciones de layouts de forma programática para entender la estructura de cada módulo. Conocer los endpoints correctos ahorra un tiempo considerable de prueba y error.
> Nota: Beam Help es soporte experto independiente para Zoho — no somos el soporte oficial de Zoho.
---
Paso a paso
Paso 1. Para recuperar todos los layouts de un módulo específico, envía una solicitud GET al endpoint /settings/layouts, pasando el nombre del módulo como parámetro de consulta module. Por ejemplo, para obtener los layouts del módulo Leads llamarías a GET /settings/layouts?module=Leads. [4]
Paso 2. El método subyacente acepta un único argumento de tipo cadena que representa el nombre del módulo (m), y la API de Zoho CRM devuelve la lista completa de layouts configurados para ese módulo. [4]
# Example usage
layouts = get_layouts(m="Leads")Paso 3. Si ya conoces el layout específico que necesitas, utiliza el endpoint de layout individual en su lugar: GET /settings/layouts/{lid}, donde {lid} es el ID del layout. Igualmente debes pasar el nombre del módulo como parámetro de consulta junto al ID del layout. [5]
Paso 4. La firma del método para obtener un layout individual acepta dos argumentos — el nombre del módulo (m) y el ID del layout (lid). [5]
# Example usage
layout = get_layout(m="Leads", lid="4567890123456789")Paso 5. Una vez que tienes un ID de layout, puedes ir un nivel más profundo y recuperar los campos pertenecientes a ese layout. Usa GET /api/v1/layouts/{layoutId}/fields, pasando el layoutId como parámetro de ruta. Se puede proporcionar un parámetro de paginación opcional (p) como diccionario si la lista de campos es extensa. [7]
# Example usage
fields = get_layout_fields(layoutId="4567890123456789", p={"page": 1})Paso 6. Utiliza la respuesta de campos para entender exactamente qué campos están presentes en un layout, su orden y cualquier metadato asociado — esto es especialmente útil al mapear datos del CRM a un sistema externo o al validar que los campos obligatorios existen antes de enviar registros. [7]
---
Errores comunes
- Uso incorrecto de mayúsculas en el nombre del módulo. Los nombres de módulo en la API de Zoho CRM distinguen entre mayúsculas y minúsculas en muchos contextos (por ejemplo,
Leadsy noleads). Utiliza siempre el nombre de la API tal como aparece en la configuración de tu CRM, no la etiqueta de visualización. - ID de layout ausente. El endpoint de layout individual (
/settings/layouts/{lid}) requiere un ID de layout válido. Si omites los pasos 1 y 2 e intentas adivinar un ID, la solicitud fallará. Recupera siempre la lista completa primero para obtener IDs válidos. [4][5] - Confundir layouts de CRM con layouts de Desk. Los endpoints
/settings/layoutsdescritos aquí son específicos de Zoho CRM. Zoho Desk utiliza una estructura de ruta diferente (/api/v1/layouts/{layoutId}/fields) para la recuperación de campos de sus propios layouts. Asegúrate de estar apuntando a la URL base del producto correcto. [4][7]
---
Qué verificar
- Confirma que el nombre del módulo es el nombre de la API (no el nombre de visualización) cruzando la información con la configuración de módulos de tu CRM antes de realizar la llamada. [4]
- Verifica el ID de layout devuelto en la respuesta de todos los layouts y comprueba que coincide con el layout que deseas inspeccionar antes de llamar a los endpoints de layout individual o de campos. [5]
- Comprueba la paginación en el endpoint de campos si tu layout contiene muchos campos — usa el parámetro opcional
ppara paginar los resultados y asegurarte de que no se omite ningún campo. [7]