Skip to main content
GET
/
public_api
/
customers
/
cURL
curl --request GET \
  --url https://api.cakto.com.br/public_api/customers/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "João da Silva",
      "email": "joao@example.com",
      "birthDate": "1990-05-15",
      "phone": "*********7777",
      "docType": "cpf",
      "docNumber": "111******77"
    },
    {
      "id": 2,
      "name": "Maria Oliveira",
      "email": "maria@example.com",
      "birthDate": null,
      "phone": "*********1234",
      "docType": "cnpj",
      "docNumber": "123******56"
    }
  ]
}

​
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

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.
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.
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.
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.
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

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.
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.
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âmetro search. A busca é textual e abrange os seguintes campos:
  • name — Nome do cliente
  • email — E-mail do cliente
  • phone — Telefone do cliente
  • docNumber — Número do documento
Exemplo: ?search=joao Retorna clientes que possuam o termo informado em qualquer um dos campos suportados.

​
Ordenação

Utilize o parâmetro ordering para organizar os clientes da forma mais conveniente para sua operação. Campos suportados: id, name
Use o prefixo - para ordenação decrescente.
Exemplo: ?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

​
Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Query Parameters

​
limit
integer

Número de resultados a serem retornados por página.

​
page
integer

Número da página a ser retornada.

​
search
string

Busca textual por nome, email, telefone ou documento do cliente.

​
ordering
string

Campo de ordenação. Use o prefixo - para ordem decrescente. Campos suportados id, name.

Response

Corpo da resposta status 200

​
count
integer
Example:

123

​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"

​
results
object[]