Listar clientes no Baremetrics, por uma API

Lista os clientes de uma fonte com oid, e-mail, LTV e MRR atual em centavos, planos atuais e se estão ativos ou cancelados. A resposta tem meta.pagination.has_more; envie page para ler a próxima página.

Identificador
baremetrics_list_customers

A chamada

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

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

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
source_idstringSimId of the source, from List sources.
searchstringNãoText matched against the oid, email, notes and name of the customer.
sortstringNãoSort field. The default is created.Valores: created, ltv
orderstringNãoSort order. The default is asc.Valores: asc, desc
pageintegerNãoPage to read. The first page is 0.
per_pageintegerNãoCustomers per page, up to 200. The default is 30.

Conexões possíveis

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

Outras tools do Baremetrics

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.