Les vues personnalisées dans Zoho CRM peuvent être récupérées soit sous forme de liste complète pour un module donné, soit sous forme d'une vue unique par son identifiant, grâce à deux endpoints d'API dédiés disponibles via l'API des paramètres CRM.
Pourquoi c'est important
Lors de la création d'intégrations ou d'automatisations sur Zoho CRM, vous avez souvent besoin de savoir quelles vues personnalisées existent pour un module — par exemple, pour reproduire un filtre enregistré dans un tableau de bord externe ou pour vérifier qu'une vue existe avant d'y faire référence par programmation. Récupérer une vue spécifique par son identifiant vous permet d'inspecter sa configuration exacte sans avoir à charger la liste entière. En tant que support expert indépendant (et non le support officiel de Zoho), Beam Help documente ces endpoints afin que votre équipe puisse les utiliser en toute confiance.
Étape par étape
Étape 1. Pour récupérer toutes les vues personnalisées d'un module, envoyez une requête GET vers l'endpoint /settings/customviews, en passant le nom API du module comme paramètre de requête module.[1] Par exemple, pour lister toutes les vues personnalisées du module Leads, votre requête ciblerait /settings/customviews?module=Leads.[1]
Étape 2. L'appel sous-jacent suit ce schéma — votre client envoie un GET vers /settings/custom_views avec {"module": m} comme charge utile de paramètre, où m est la chaîne de caractères du nom du module.[1] Cette opération est catégorisée comme un appel de type settings et a été vérifiée comme SAFE, sans risque de modification des données.[3]
Étape 3. Pour récupérer une vue personnalisée unique par son identifiant, utilisez plutôt l'endpoint /settings/custom_views/{vid}, où {vid} est l'identifiant unique de la vue.[2] Vous devez toujours fournir le nom du module comme paramètre de requête en plus de l'identifiant de la vue.[2]
Étape 4. L'appel pour une vue unique suit ce schéma — votre client envoie un GET vers /settings/custom_views/{vid} avec {"module": m} comme paramètre, et vid est la chaîne de l'identifiant de vue que vous souhaitez inspecter.[2] Comme l'endpoint de liste, cette opération est classifiée comme SAFE sans effets secondaires en écriture.[8]
Étape 5. Si vous travaillez dans la couche d'outillage de Beam Help, l'outil getcustomview encapsule cet endpoint et accepte m (nom du module) et view_id comme paramètres.[7] Transmettez les deux valeurs et l'outil se charge de la construction du chemin pour vous.[7]
Erreurs courantes
- Paramètre module manquant. Les deux endpoints nécessitent le paramètre
module— l'omettre entraînera une réponse en échec ou ambiguë, car les vues personnalisées Zoho CRM sont toujours limitées à un module spécifique.[1][2] - Confusion entre les deux endpoints.
/settings/customviews(sans suffixe de chemin) renvoie la liste complète pour un module, tandis que/settings/customviews/{vid}cible une vue spécifique. Utiliser l'endpoint de liste lorsque vous disposez déjà d'un identifiant de vue est inefficace et renvoie plus de données que nécessaire.[1][2] - Identifiants de vue obsolètes. Les identifiants de vue sont stables mais peuvent devenir invalides si une vue personnalisée est supprimée dans l'interface CRM. Gérez toujours de manière appropriée une réponse indiquant une vue manquante dans votre code d'intégration.[8]
Ce qu'il faut vérifier
- Confirmez que le nom API du module que vous transmettez correspond exactement au nom interne utilisé par Zoho CRM (par ex.,
Leads,Contacts,Deals) — une discordance ne renverra aucun résultat.[1] - Vérifiez que l'identifiant de vue que vous fournissez à
/settings/custom_views/{vid}a été obtenu lors d'un appel de liste précédent ou depuis les paramètres CRM, afin d'éviter de référencer une vue supprimée ou inexistante.[2][8] - Assurez-vous que vos identifiants API ont accès à la portée settings, car les deux endpoints se trouvent sous
/settings/et peuvent nécessiter des autorisations élevées au-delà de l'accès standard au niveau des enregistrements.[3][8]