CRM Help

Método searchRecords

 Finalidade

Você pode usar o método searchRecords  para obter a lista de registros que atendam ao critério de pesquisa.

 URL de solicitação

Formato XML:
https://crm.zoho.com/crm/private/xml/Leads/searchRecords?authtoken=Auth Token&scope=crmapi&criteria=(((Last Name:Steve)AND(Company:Zillum))OR(Lead Status:Contacted))

Formato JSON:
https://crm.zoho.com/crm/private/json/Leads/searchRecords?authtoken=Auth Token&scope=crmapi&criteria=(((Last Name:Steve)AND(Company:Zillum))OR(Lead Status:Contacted))

 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.
criteria*stringEspecifique os critérios de pesquisa conforme mostrado na seção URL de solicitação.
selectColumnsStringModule(optional columns) i.e, Leads(Last Name,Website,Email) OU All
fromIndexNúmero inteiroValor Padrão – 1
toIndexNúmero inteiroValor padrão – 20
Valor de intervalo máximo – 200
[Valor de intervalo máximo = toIndex – fromIndex]
lastModifiedTimeaaaa-MM-dd HH:mm:ss Valor padrão: null
Se você especificar a hora, os dados criados/modificados serão buscados depois da hora definida.
newFormat Número inteiro newFormat=1: Para excluir campos com valor "null" ao inserir dados da sua conta CRM.
newFormat=2: Para incluir campos com valor "null" ao inserir dados da sua conta CRM.

* – Parâmetro obrigatório

Nota:

  • Você pode acionar esse método apenas 60 vezes por minuto.
  • O limite máximo de chamadas que você pode fazer por dia é 10000. No entanto, se a contagem de API do seu plano for menor que 10000, a contagem da organização será aplicada ao usar esse método.
  • Você pode usar um máximo de cinco critérios (com as mesmas colunas ou com diferentes) com as condições de equals e startsWith. Outros operadores não são compatíveis com este método.
  • Consulte a página Notas de versão  para saber mais sobre as melhorias feitas na implementação API.

 Amostra de resposta

<response uri="/crm/private/xml/Leads/searchRecords">

<result>
<Leads>
<row no="1">
<FL val="LEADID">508020000000556003</FL>
<FL val="SMOWNERID">508020000000050003</FL>
<FL val="Lead Owner">
<![CDATA[ John Doe ]]>
</FL>
<FL val="Company">
<![CDATA[ Zillum ]]>
</FL>
<FL val="Last Name">
<![CDATA[ Steve ]]>
</FL>
<FL val="No of Employees">
<![CDATA[ 0 ]]>
</FL>
<FL val="Annual Revenue">
<![CDATA[ 0 ]]>
</FL>
<FL val="SMCREATORID">508020000000050003</FL>
<FL val="Created By">
<![CDATA[ John Doe ]]>
</FL>
<FL val="MODIFIEDBY">508020000000050003</FL>
<FL val="Modified By">
<![CDATA[ John Doe ]]>
</FL>
<FL val="Created Time">
<![CDATA[ 2013-06-26 10:37:48 ]]>
</FL>
<FL val="Modified Time">
<![CDATA[ 2013-06-26 10:37:48 ]]>
</FL>
<FL val="Email Opt Out">
<![CDATA[ false ]]>
</FL>
<FL val="Currency">
<![CDATA[ INR ]]>
</FL>
<FL val="Exchange Rate">
<![CDATA[ 1.000000000 ]]>
</FL>
<FL val="Last Activity Time">
<![CDATA[ 2013-06-26 10:37:48 ]]>
</FL>
</row>
</Leads>
</result>
</response>

Share this post : FacebookTwitter

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

Escreva para nós: support@zohocrm.com