Aide CRM

Méthode getUsers

Objectif

Vous pouvez utiliser la méthode getUsers  pour obtenir la liste des utilisateurs de votre organisation.

URL de demande

Format XML :
https://crm.zoho.com/crm/private/xml/Users/getUsers?authtoken=Auth Token&scope=crmapi&type=Type d'utilisateur

Format JSON :
https://crm.zoho.com/crm/private/json/Users/getUsers?authtoken=Auth Token&scope=crmapi&type=The Type of User

Paramètres de demande

ParamètreType de donnéesDescription
authtoken*ChaîneChaîne alphanumérique chiffrée utilisée pour l'authentification de vos identifiants Zoho.
scope*ChaîneEntrez la valeur crmapi.
newFormatEntiernewFormat=1 : pour exclure les champs avec des valeurs « null » lors de l'insertion de données à partir de votre compte CRM.
newFormat=2 : pour inclure des champs avec des valeurs « null » lors de l'insertion de données à partir de votre compte CRM.
versionEntierversion = 1 : (valeur par défaut) permet de récupérer les réponses en fonction de la version d'API mise en œuvre précédemment, c.-à-d. avant les améliorations apportées.
version = 2 : permet de récupérer les réponses en fonction de l'API la plus récente.
type*ChaîneCe paramètre prend l'une des valeurs suivantes :
AllUsers
Pour établir la liste de tous les utilisateurs de votre organisation (utilisateurs actifs et inactifs)
ActiveUsers
Pour obtenir la liste de tous les utilisateurs actifs 
DeactiveUsers
Pour obtenir la liste de tous les utilisateurs qui ont été désactivés
AdminUsers
Pour obtenir la liste de tous les utilisateurs bénéficiant de droits d'administrateur
ActiveConfirmedAdmins
Pour obtenir la liste des utilisateurs bénéficiant de droits d'administrateur et qui ont également été confirmés

* - Paramètre obligatoire

Remarque :

  • consultez la page des Notes de mise à jour  pour en savoir plus sur les améliorations apportées à la mise en œuvre de l'API.

Exemple de réponse

Dans ce cas, type = AllUsers

<users>
   <user id="501240000000541313" email="andrew@zohocorp.com" role="CEO" profile="Administrator" status="active" confirm="true">andrew</user>
   <user id="501234132412341135" email="tyson@zohocorp.com" role="Manager" profile="Standard" status="active" confirm="true">tyson</user>
   <user id="501234565431234521" email="kelly@zohocorp.com" role="Manager" profile="Standard" status="active" confirm="false">kelly</user>
   <user id="512343454676898643" email="frank@zohocorp.com" role="CEO" profile="Standard" status="active" confirm="false">frank</user>
   <user id="512445678909865545" email="sophia@zohocorp.com" role="CEO" profile="Administrator" status="active" confirm="true">sophia</user>
</users>

Si version = 2, vous obtiendrez l'ID de l'organisation dans la réponse. Cependant, les informations sur la société doivent être disponibles dans vos enregistrements CRM pour obtenir l'ID de l'organisation dans la réponse.

<users orgid="501240000000652982">
   <user id="501240000000541313" zuid="11381966" website="null" mobile="888-555-2146" fax="null" street="null" city="null" state="null" country="null" zip="null" language="en_US" timezone="PST8PDT" email="andrew@zohocorp.com" role="CEO" profile="Administrator" status="active" confirm="true">andrew</user>
   <user id="512445678909865545" zuid="11385946" website="null" mobile="null" fax="null" street="null" city="null" state="null" country="null" zip="null" language="en_US" timezone="America/Los_Angeles" email="sophia@zohocorp.com" role="CEO" profile="Administrator" status="active" confirm="true">sophia</user>
</users>

Share this post : FacebookTwitter

Vous ne trouvez toujours pas ce que vous cherchez?

Écrivez-nous: support@zohocrm.com