getUsers methode
Doel
U kunt de getUsers methode gebruiken voor het verkrijgen van de lijst van gebruikers in uw bedrijf.
URL van het verzoek
XML-indeling:
https://crm.zoho.com/crm/private/xml/Users/getUsers?authtoken=Auth Token&scope=crmapi&type=The Type of User
JSON-indeling:
https://crm.zoho.com/crm/private/json/Users/getUsers?authtoken=Auth Token&scope=crmapi&type=The Type of User
Parameters van het verzoek
| Parameter | Gegevenstype | Beschrijving |
| authtoken* | String | Versleutelde alfanumerieke tekenreeks ter verificatie van uw Zoho inloggegevens. |
| scope* | String | Voer als waarde crmapi in. |
| newFormat | Integer | newFormat=1: Om velden met 'null'-waarden uit te sluiten wanneer u gegevens uit uw CRM-account invoegt. newFormat=2: Om velden met 'null'-waarden op te nemen wanneer u gegevens uit uw CRM-account invoegt. |
| version | Integer | version = 1: (standaardwaarde) Hiermee worden responses opgehaald op basis van de eerdere API-implementatie, d.w.z. van vóór de doorgevoerde verbeteringen. version = 2: Hiermee worden responses opgehaald op basis van de meest recente API-implementatie. |
| type* | String | Deze parameter neemt een van de volgende waarden: AllUsers Voor het opstellen van een lijst van alle gebruikers in uw bedrijf (zowel actieve als inactieve gebruikers) ActiveUsers Voor het verkrijgen van de lijst van alle actieve gebruikers DeactiveUsers Voor het verkrijgen van de lijst van alle gedeactiveerde gebruikers AdminUsers Voor het verkrijgen van de lijst van alle gebruikers met beheerdersbevoegdheden ActiveConfirmedAdmins Voor het verkrijgen van de lijst van gebruikers met beheerdersbevoegdheden en die ook zijn bevestigd |
* - Verplichte parameter
Opmerking:
- Raadpleeg de Releaseopmerkingen voor meer informatie over doorgevoerde verbeteringen in de API-implementatie.
Voorbeeld response
In dit geval, 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>
Als version = 2, krijgt u org id in de response. Bedrijfsgegevens moeten echter wel beschikbaar zijn in uw CRM-records om org id in de response te krijgen.
<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>