cURL
curl --request GET \
--url https://api.cakto.com.br/public_api/customers/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cakto.com.br/public_api/customers/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cakto.com.br/public_api/customers/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cakto.com.br/public_api/customers/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.cakto.com.br/public_api/customers/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyHttpResponse<String> response = Unirest.get("https://api.cakto.com.br/public_api/customers/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.cakto.com.br/public_api/customers/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": 123,
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"docNumber": "<string>",
"birthDate": "2023-12-25",
"docType": "cpf"
}
]
}{
"detail": "As credenciais de autenticação não foram fornecidas."
}Clientes
Listar Clientes
Consulte sua base de compradores pagantes para análises, integrações com CRM, segmentação de campanhas e acompanhamento do relacionamento com clientes.
GET
/
public_api
/
customers
/
cURL
curl --request GET \
--url https://api.cakto.com.br/public_api/customers/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cakto.com.br/public_api/customers/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cakto.com.br/public_api/customers/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cakto.com.br/public_api/customers/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.cakto.com.br/public_api/customers/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyHttpResponse<String> response = Unirest.get("https://api.cakto.com.br/public_api/customers/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.cakto.com.br/public_api/customers/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": 123,
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"docNumber": "<string>",
"birthDate": "2023-12-25",
"docType": "cpf"
}
]
}{
"detail": "As credenciais de autenticação não foram fornecidas."
}Escopo
read orders
O que é este endpoint?
Este endpoint permite acessar todos os clientes que já realizaram pelo menos uma compra paga nos seus produtos. É a porta de entrada para entender quem são seus compradores, como está evoluindo sua base e como usar esses dados para crescer de forma mais inteligente. Por motivos de privacidade e segurança, informações sensíveis como telefone e documento são retornadas de forma mascarada.Por que consultar sua base de clientes?
Ter acesso consolidado aos seus compradores vai muito além de uma simples listagem. É a base para estratégias de retenção, automação e crescimento.Segmentar campanhas
Identifique grupos de clientes para criar ofertas direcionadas, reengajamento e campanhas personalizadas.
Integrar com CRM
Sincronize sua base de compradores com ferramentas de relacionamento, atendimento e automação de marketing.
Analisar crescimento
Acompanhe a evolução da base de compradores ao longo do tempo e meça a saúde da aquisição de clientes.
Suporte ágil
Localize rapidamente o cadastro de um cliente para validar compras, acompanhar pedidos ou prestar atendimento.
Casos de uso
Construir uma base para CRM
Construir uma base para CRM
Recupere todos os clientes pagantes e sincronize os dados com plataformas de CRM para centralizar o histórico de relacionamento. Dados como nome, e-mail e documento permitem criar ou atualizar contatos, iniciar fluxos de automação e organizar clientes por segmentos.
Criar segmentações para campanhas
Criar segmentações para campanhas
Localize clientes específicos para criar campanhas direcionadas, ofertas exclusivas ou estratégias de reengajamento. Combine buscas por nome, e-mail ou documento para montar listas precisas.
Identificar compradores recorrentes
Identificar compradores recorrentes
Combine este endpoint com os dados de pedidos para encontrar clientes que compram com frequência. Essa segmentação é ideal para programas de fidelidade, ofertas VIP e estratégias de retenção.
Enriquecer relatórios de vendas
Enriquecer relatórios de vendas
Utilize os dados dos clientes em conjunto com pedidos e assinaturas para construir dashboards mais completos e acompanhar métricas como total de clientes, novos compradores no mês e taxas de recorrência.
Atender com agilidade
Atender com agilidade
Quando um cliente entra em contato com o suporte, use a busca para localizar o cadastro rapidamente e validar compras, pedidos ou dados pessoais sem perder tempo.
Insights que podem ser obtidos
Crescimento da base de clientes
Crescimento da base de clientes
Acompanhe a evolução do número de compradores ao longo do tempo para entender como sua operação está expandindo e se suas estratégias de aquisição estão funcionando.
Relacionamento centralizado
Relacionamento centralizado
Utilize os dados para manter um histórico único do cliente em sistemas externos, melhorando ações de retenção, comunicação pós-venda e experiência do consumidor.
Segmentação inteligente
Segmentação inteligente
Agrupe clientes por características, comportamento de compra ou periodicidade para criar campanhas com maior taxa de conversão e menor custo de aquisição.
Busca
Localize clientes rapidamente utilizando o parâmetrosearch. A busca é textual e abrange os seguintes campos:
name— Nome do clienteemail— E-mail do clientephone— Telefone do clientedocNumber— Número do documento
?search=joao
Retorna clientes que possuam o termo informado em qualquer um dos campos suportados.
Ordenação
Utilize o parâmetroordering para organizar os clientes da forma mais conveniente para sua operação.
Campos suportados: id, name
Use o prefixo
- para ordenação decrescente.?ordering=-name — Retorna os clientes em ordem alfabética inversa (Z → A).
Response
Uma base de clientes crescente indica aquisição eficiente, mas o verdadeiro valor está na capacidade de transformar compradores em clientes recorrentes. Combine estes dados com pedidos, assinaturas e métricas de receita para acompanhar todo o ciclo de vida do cliente.
Authorizations
Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.
Query Parameters
Número de resultados a serem retornados por página.
Which field to use when ordering the results.
Número da página a ser retornada.
A search term.
Was this page helpful?