Listar clientes no Asaas, por uma API

Lista os clientes (pagadores) da conta, com filtro opcional por nome, e-mail, CPF ou CNPJ, grupo ou referência externa. A resposta traz data, totalCount e hasMore; pagine com offset e limit enquanto hasMore for true.

Identificador
asaas_list_customers

A chamada

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

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

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
namestringNãoOnly the customers with this name.
emailstringNãoOnly the customers with this email address.
cpfCnpjstringNãoOnly the customer with this CPF or CNPJ, digits only.
groupNamestringNãoOnly the customers of this group, by the group name.
externalReferencestringNãoOnly the customers with this identifier of your own system, saved in externalReference.
offsetintegerNãoPosition of the first customer of the page. The default is 0; add limit to it for the next page.
limitintegerNãoCustomers per page, from 1 to 100. The default is 10.

Conexões possíveis

O seu cliente conecta a conta do Asaas 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/asaas_list_customers. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Asaas

Ver as 12 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.