Comment obtenir les layouts dans Zoho

Récupérer les layouts dans Zoho CRM est simple dès lors que vous connaissez les bons endpoints à appeler — vous pouvez récupérer tous les layouts d'un module ou accéder à un layout précis via son ID.

Pourquoi c'est important

Les layouts dans Zoho CRM contrôlent les champs, sections et règles présentés aux utilisateurs lorsqu'ils créent ou modifient des enregistrements dans un module donné. Si vous construisez une intégration, automatisez la saisie de données ou auditez la configuration de votre CRM, vous aurez besoin de récupérer les définitions de layouts par programmation afin de comprendre la structure de chaque module. Connaître les bons endpoints vous évitera de nombreux essais-erreurs.

> Remarque : Beam Help est un support expert indépendant pour Zoho — nous ne sommes pas le support officiel de Zoho.

---

Pas à pas

Étape 1. Pour récupérer tous les layouts d'un module spécifique, envoyez une requête GET vers l'endpoint /settings/layouts, en passant le nom du module comme paramètre de requête module. Par exemple, pour obtenir les layouts du module Leads, appelez GET /settings/layouts?module=Leads. ^[4]

Étape 2. La méthode sous-jacente accepte un seul argument de type chaîne représentant le nom du module (m), et l'API Zoho CRM retourne la liste complète des layouts configurés pour ce module. ^[4]

# Example usage
layouts = get_layouts(m="Leads")

Étape 3. Si vous connaissez déjà le layout dont vous avez besoin, utilisez plutôt l'endpoint de layout unique : GET /settings/layouts/{lid}, où {lid} est l'ID du layout. Vous devez toujours passer le nom du module comme paramètre de requête en plus de l'ID du layout. ^[5]

Étape 4. La signature de la méthode pour récupérer un layout unique prend deux arguments — le nom du module (m) et l'ID du layout (lid). ^[5]

# Example usage
layout = get_layout(m="Leads", lid="4567890123456789")

Étape 5. Une fois que vous disposez d'un ID de layout, vous pouvez aller un niveau plus loin et récupérer les champs appartenant à ce layout. Utilisez GET /api/v1/layouts/{layoutId}/fields, en passant le layoutId comme paramètre de chemin. Un paramètre de pagination optionnel (p) peut être fourni sous forme de dictionnaire si la liste de champs est longue. ^[7]

# Example usage
fields = get_layout_fields(layoutId="4567890123456789", p={"page": 1})

Étape 6. Utilisez la réponse contenant les champs pour comprendre exactement quels champs sont présents dans un layout, leur ordre et les métadonnées associées — cela est particulièrement utile pour mapper les données CRM vers un système externe ou valider que les champs obligatoires existent avant d'envoyer des enregistrements. ^[7]

---

Erreurs courantes

• Casse incorrecte du nom de module. Les noms de modules de l'API Zoho CRM sont sensibles à la casse dans de nombreux contextes (par ex., Leads et non leads). Utilisez toujours le nom API tel qu'il apparaît dans les paramètres de votre CRM, et non le libellé d'affichage.
• ID de layout manquant. L'endpoint de layout unique (/settings/layouts/{lid}) nécessite un ID de layout valide. Si vous sautez les étapes 1 et 2 et tentez de deviner un ID, la requête échouera. Récupérez toujours la liste complète en premier pour obtenir des ID valides. ^[4][5]
• Confusion entre les layouts CRM et les layouts Desk. Les endpoints /settings/layouts décrits ici sont spécifiques à Zoho CRM. Zoho Desk utilise une structure de chemin différente (/api/v1/layouts/{layoutId}/fields) pour la récupération de ses propres champs de layout. Assurez-vous de cibler l'URL de base du bon produit. ^[4][7]

---

Ce qu'il faut vérifier

• Confirmez que le nom du module est bien le nom API (et non le nom d'affichage) en le vérifiant dans les paramètres de votre module CRM avant d'effectuer l'appel. ^[4]
• Vérifiez que l'ID de layout retourné dans la réponse tous-les-layouts correspond bien au layout que vous souhaitez inspecter avant d'appeler les endpoints de layout unique ou de champs. ^[5]
• Vérifiez la pagination sur l'endpoint des champs si votre layout contient de nombreux champs — utilisez le paramètre optionnel p pour parcourir les résultats et vous assurer qu'aucun champ n'est omis. ^[7]