CRM Help

Método getUsers

Finalidad

Puede utilizar el método getUsers  para obtener la lista de usuarios de su organización.

URL de la solicitud

Formato XML:
https://crm.zoho.com/crm/private/xml/Users/getUsers?authtoken=Auth Token&scope=crmapi&type=The Type of User

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

Parámetros de la solicitud

ParámetroTipo de datosDescripción
authtoken*CadenaCadena alfanumérica encriptada para autenticar sus credenciales de Zoho.
scope*CadenaEspecificar el valor como crmapi.
newFormatEnteronewFormat=1: para excluir campos con valores "null" mientras inserta datos en su cuenta de CRM.
newFormat=2: para incluir campos con valores "null" mientras inserta datos en su cuenta de CRM.
versiónEnteroversion = 1 (valor predeterminado): mediante este valor, se capturarán respuestas basadas en la implementación de una API anterior, es decir, previa a las mejoras realizadas.
version = 2: mediante este valor, se capturarán respuestas basadas en la implementación de la API más reciente.
tipo*CadenaEste parámetro tendrá uno de los siguientes valores:
AllUsers
Para obtener una lista de todos los usuarios de su organización (tanto los usuarios activos como los inactivos)
ActiveUsers
Para obtener la lista de todos los usuarios activos 
DeactiveUsers
Para obtener la lista de todos los usuarios que se desactivaron
AdminUsers
Para obtener la lista de todos los usuarios con privilegios de administrador
ActiveConfirmedAdmins
Para obtener la lista de usuarios con privilegios de administrador y que también estén confirmados

* Parámetro obligatorio

Nota:

  • Consulte la página Notas de la versión  para obtener más información sobre las mejoras realizadas en la implementación de la API.

Ejemplo de respuesta

En este caso, escriba = 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 el parámetro es version = 2, obtendrá el ID de la organización en la respuesta. Sin embargo, la información de la empresa debe estar disponible en los registros de su CRM para obtener el ID de la organización en la respuesta.

<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

Todavía no puede encontrar lo que está buscando?

Escríbenos: support@zohocrm.com