CRM Help

Método getUsers

Finalidade

Você pode usar o método getUsers  para obter a lista de usuários em sua organização.

URL de solicitação

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 solicitação

ParâmetroTipo de dadosDescrição
authtoken*StringSequências alfanuméricas criptografadas para autenticar suas credenciais do Zoho.
scope*StringEspecifique o valor como crmapi.
newFormatNúmero inteiroNewFormat=1: para excluir os campos com valores "null" ao inserir dados de sua conta CRM.
newFormat=2: para incluir campos com valores "null", ao inserir dados de sua conta CRM.
versionNúmero inteiroversion = 1: (valor padrão) Irá buscar respostas com base na implementação da API anterior, ou seja, antes dos aprimoramentos feitos.
version = 2: irá buscar respostas com base na implementação da API mais recente.
type*StringEste parâmetro assume um dos seguintes valores:
AllUsers
Para listar todos os usuários em sua organização (tanto usuários ativos como inativos)
ActiveUsers
Para obter a lista de todos os usuários ativos 
DeactiveUsers
Para obter a lista de todos os usuários que foram desativados
AdminUsers
Para obter a lista de todos os usuários com privilégios administrativos
ActiveConfirmedAdmins
Para obter a lista de usuários com privilégios administrativos e que também estão confirmados

* – Parâmetro obrigatório

Nota:

  • Consulte a página Notas de versão  para saber mais sobre as melhorias feitas na implementação API.

Amostra de resposta

Nesse caso, digite = 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>

Se version = 2, você obterá id da organização na resposta. No entanto, os detalhes da empresa devem estar disponíveis nos seus registros do CRM para obter o id da organização na resposta.

<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

Ainda não consegue encontrar o que você está procurando?

Escreva para nós: support@zohocrm.com