La récupération des enregistrements liés dans Zoho CRM nécessite une seule requête GET ciblant un enregistrement parent spécifique et nommant la liste associée (sous-module) que vous souhaitez récupérer — voici comment procéder correctement.
Pourquoi c'est important
Lorsque vous travaillez avec les données de Zoho CRM, les enregistrements existent rarement de manière isolée. Un Contact peut avoir des Deals associés, un Deal peut avoir des Activités liées, et un Compte peut avoir plusieurs Cases ouverts. Savoir comment extraire ces listes associées par programmation vous permet de créer des intégrations plus riches, d'automatiser les relances et d'afficher le contexte complet de n'importe quel enregistrement sans naviguer manuellement dans l'interface.
Étape par étape
Étape 1. Identifiez les trois paramètres de chemin requis avant tout appel : le module (m), l'identifiant de l'enregistrement (rid), et le nom API de la liste associée (rel). Par exemple, pour récupérer les Contacts liés à un Compte spécifique, m serait Accounts, rid serait l'identifiant unique du Compte, et rel serait Contacts. [3]
Étape 2. Construisez votre requête en utilisant le modèle d'endpoint GET /{m}/{rid}/{rel}. L'opération est nommée getrelatedrecords dans la couche API de Zoho CRM. Un appel Python minimal ressemble à ceci : [3]
get_related_records(m="Accounts", rid="<record_id>", rel="Contacts")
La méthode déclenche en interne une requête GET vers /<m>/<rid>/<rel> et accepte un paramètre optionnel p pour des options de requête supplémentaires telles que la pagination. [3]
Étape 3. Transmettez les options de pagination ou de filtrage via l'argument dictionnaire p si vous attendez un grand nombre de résultats. Le paramètre p correspond directement aux options de chaîne de requête prises en charge par l'endpoint, vous pouvez donc inclure des clés comme page ou per_page selon vos besoins. [3]
Étape 4. Une fois la réponse reçue, vous pouvez créer des liens directs vers n'importe quel enregistrement retourné. Le modèle d'URL du CRM suit le format https://crm.zoho.{dc}/crm/tab/{Module}/{RecordId}, où dc est le suffixe de votre centre de données (par ex., com, eu, in). [1] Si votre organisation utilise un centre de données non par défaut, substituez le suffixe correct afin que les liens se résolvent correctement. [1]
Étape 5. Si vous travaillez dans une couche d'orchestration d'outils (comme celle que notre équipe chez Beam Help construit sur Zoho CRM), le résultat de getrelatedrecords peut être transmis directement à un utilitaire de construction de liens. Cet utilitaire accepte le dictionnaire de résultats brut, le nom de l'outil, les paramètres utilisés, le type d'application et les identifiants du centre de données/de l'organisation, puis retourne une liste d'objets URL nommés prêts à être affichés dans une interface de chat ou un tableau de bord. [8]
---
*Beam Help est un support expert indépendant pour Zoho — nous ne sommes pas le support officiel de Zoho.*
---
Erreurs courantes
- Nom
relincorrect. Le nom de la liste associée doit correspondre au nom API attendu par Zoho, et non à l'étiquette d'affichage. Par exemple, l'interface peut afficher « Open Activities » mais le nom API pourrait êtreActivities. Consultez la référence API du CRM pour obtenir la chaîne exacte. - Identifiant d'enregistrement manquant. Passer un
ridvide ou mal formé entraînera l'échec silencieux de la requête ou le retour d'un payload d'erreur. Vérifiez toujours que l'identifiant de l'enregistrement parent est une chaîne non vide avant d'appeler l'endpoint. [3] - Incompatibilité de centre de données. Si votre organisation CRM est hébergée sur le centre de données EU ou IN et que vous codez en dur
.comdans les URLs construites, les liens seront inaccessibles. Dérivez toujours la valeurdcà partir des métadonnées de connexion stockées. [1] - Paramètre
pvide. L'argumentpprend par défaut un dictionnaire vide lorsqu'il n'est pas fourni (p or {}), donc l'omettre est sans danger — mais oublier de paginer sur de grandes listes associées signifie que vous ne recevrez que la première page de résultats. [3]
Ce qu'il faut vérifier
- Confirmez que la valeur
relque vous utilisez correspond exactement au nom API de la liste associée dans votre configuration CRM, et non simplement à son étiquette dans l'interface. [3] - Vérifiez que la valeur
dc(centre de données) stockée dans votre enregistrement de connexion correspond au domaine sur lequel votre organisation CRM est réellement hébergée, afin que les liens d'enregistrement générés se résolvent correctement. [1] - Après avoir récupéré les résultats, vérifiez que la réponse contient les sous-enregistrements attendus et qu'il ne s'agit pas d'un objet d'erreur — un
ridmanquant ou incorrect est la cause la plus fréquente d'une réponse vide ou en échec. [3]