Listar clientes

GET /api/v1/clientes

Retorna, em páginas de até 500 registros, somente os clientes do produtor autenticado. O escopo usa o produtor pai do token (produtor_id quando o token pertence a uma subconta), igual a /api/v1/pacotes e /api/v1/produtos. Esta rota lê a tabela diretamente, então também lista cadastros unificados que GET /api/v1/clientes/{id} recusa com 401.

GET Requisição

bash

curl -X GET "https://ev.paylog.cash/api/v1/clientes" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

javascript

const response = await fetch("https://ev.paylog.cash/api/v1/clientes", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
  },
});

python

import requests

response = requests.get(
    "https://ev.paylog.cash/api/v1/clientes",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
    },
)

ruby

require "net/http"
require "json"
require "uri"

uri = URI("https://ev.paylog.cash/api/v1/clientes")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer YOUR_TOKEN"
request["Accept"] = "application/json"

response = http.request(request)

200 Resposta

json

{
  "current_page": 0,
  "first_page_url": "https://example.com",
  "from": 0,
  "last_page": 0,
  "last_page_url": "https://example.com",
  "links": [
    {
      "url": "string",
      "label": "string",
      "active": true
    }
  ],
  "next_page_url": "https://example.com",
  "path": "https://example.com",
  "per_page": 0,
  "prev_page_url": "https://example.com",
  "to": 0,
  "total": 0,
  "data": [
    {
      "id": 0,
      "sexo": "string",
      "cpf": "string",
      "nome": "string",
      "data_nascimento": "string",
      "inscricao_estadual": "string",
      "email": "[email protected]",
      "endereco": "string",
      "numero": "string",
      "complemento": "string",
      "bairro": "string",
      "cidade": "string",
      "estado": "string",
      "pais": "string",
      "cep": "string",
      "telefone": "string",
      "celular": "string",
      "referencia_externa": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}

Parâmetros

Consulta

page integer Opcional: Opcional. Número da página da paginação.

Respostas

200

Página de clientes.

application/json

object

current_page integer Obrigatório
first_page_url string uri Obrigatório
from integer aceita nulo Obrigatório
last_page integer Obrigatório
last_page_url string uri Obrigatório
links array Obrigatório
Itens
object

url string aceita nulo Obrigatório

label string Obrigatório

active boolean Obrigatório
next_page_url string uri aceita nulo Obrigatório
path string uri Obrigatório
per_page integer Obrigatório
prev_page_url string uri aceita nulo Obrigatório
to integer aceita nulo Obrigatório
total integer Obrigatório
data array Obrigatório
Itens
object

Cliente devolvido por GET /api/v1/clientes (dentro de data[]) e por GET /api/v1/clientes/{id} (dentro de cliente). Todas as chaves estão sempre presentes, mas quase todas as colunas são anuláveis no banco e podem vir null em cadastros históricos. As datas NÃO usam o mesmo formato nos dois endpoints — veja a descrição de created_at.

id integer Obrigatório

ID interno do cliente.

sexo string aceita nulo

Sexo informado pelo produtor.

cpf string aceita nulo Obrigatório

CPF ou CNPJ armazenado para o cliente.

nome string aceita nulo Obrigatório

Nome completo ou razão social.

data_nascimento string aceita nulo

Data de nascimento. Na listagem vem como YYYY-MM-DD; na consulta individual e no PUT vem serializada pelo modelo em ISO 8601 (1990-05-18T00:00:00.000000Z).

inscricao_estadual string aceita nulo

Inscrição estadual quando aplicável.

email string email aceita nulo Obrigatório

E-mail do cliente.

endereco string aceita nulo Obrigatório

Logradouro.

numero string aceita nulo Obrigatório

Número do endereço.

complemento string aceita nulo

Complemento opcional.

bairro string aceita nulo Obrigatório

Bairro.

cidade string aceita nulo Obrigatório

Cidade.

estado string aceita nulo Obrigatório

UF ou estado informado.

pais string aceita nulo Obrigatório

País.

cep string aceita nulo Obrigatório

CEP do endereço.

telefone string aceita nulo Obrigatório

Telefone principal.

celular string aceita nulo

Celular opcional.

referencia_externa string aceita nulo

Identificador opcional no sistema do produtor.

created_at string aceita nulo Obrigatório

Criação. A listagem lê direto do banco e devolve YYYY-MM-DD HH:mm:ss (2026-07-22 12:20:00); a consulta individual e o PUT devolvem ISO 8601 (2026-07-22T12:20:00.000000Z). Aceite os dois formatos.

updated_at string aceita nulo Obrigatório

Última atualização. Mesma divergência de formato descrita em created_at.

401

Token Bearer ausente ou inválido.

application/json

object

Mensagem de erro ou informação. Alguns erros legados omitem code.

code integer

Código numérico quando fornecido pelo endpoint.
message string

Mensagem legível.

403

O token é válido, mas a conta não possui a permissão necessária para esta operação. O envelope é gerado pelo tratador global de exceções e usa a chave errors (string), não message.

application/json

object

Envelope produzido pelo tratador global de exceções para falhas HTTP que não são geradas pelos controladores — principalmente 403 (permissão ausente) e 405 (verbo não suportado). Difere dos erros dos controladores por usar errors no lugar de message.

errors string Obrigatório

Mensagem da exceção HTTP.
code integer Obrigatório

Código HTTP repetido no corpo.