Listar contatos no Zendesk Sell, por uma API

Lista os contatos que o usuário pode ver, pessoas e organizações, filtrados pelos argumentos informados, 25 por página por padrão. Cada item traz o registro em data, e meta.count diz quantos vieram na página. Pagine com page e per_page.

Identificador
zendesk_sell_list_contacts

A chamada

POST https://connect.reportei.com/api/tools/zendesk_sell_list_contacts/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "ids": "<ids>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
idsstringNãoComma-separated ids of the contacts to return, for example 1,2,3, from List contacts or Create contact.
is_organizationbooleanNãotrue returns only organizations, false only people.
contact_idintegerNãoId of an organization contact, from List contacts, to return the people who work for it.
owner_idintegerNãoId of the user who owns the contacts, from List users.
namestringNãoName of an organization contact.
first_namestringNãoFirst name of a person.
last_namestringNãoLast name of a person.
emailstringNãoEmail address of the contact.
customer_statusstringNãoCustomer status.Valores: none, current, past
prospect_statusstringNãoProspect status.Valores: none, current, lost
sort_bystringNãoField to sort by: id, name, first_name, last_name, email, created_at or updated_at. Append :desc for descending order, for example last_name:desc.
pageintegerNãoPage number, starting at 1.
per_pageintegerNãoContacts per page, up to 100. The default is 25.

Conexões possíveis

O seu cliente conecta a conta do Zendesk Sell uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/zendesk_sell, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/zendesk_sell_list_contacts. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Zendesk Sell

Ver as 14 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.