Listar contatos no Salesflare, por uma API

Lista os contatos do time, 20 por página por padrão. Pagine com limit e offset; uma página menor que limit é a última.

Identificador
salesflare_list_contacts

A chamada

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

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

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
searchstringNãoText to search for in the contacts.
namestringNãoName of the contact.
emailstringNãoEmail address of the contact.
phone_numberstringNãoPhone number of the contact.
domainstringNãoDomain of the email address, such as acme.com.
accountarrayNãoIds of accounts, from List accounts: only the contacts linked to them.
includeArchivedbooleanNãoAlso returns archived contacts.
order_byarrayNãoSort keys, each a field name for ascending or the name followed by desc, such as name desc.
limitintegerNãoContacts per page. The default is 20.
offsetintegerNãoContacts to skip, for the next page.

Conexões possíveis

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

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

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/salesflare_list_contacts. Ele vira a definição de tool do seu agente sem conversão.

Veja o Connect aplicado ao seu produto.

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