Skip to main content
GET
/
api
/
v1
/
public
/
clients
Listar clientes
curl --request GET \
  --url https://api.indiqai.com/api/v1/public/clients \
  --header 'X-API-Key: <x-api-key>'
{
  "clients": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "nome": "João Silva",
      "email": "joao@email.com",
      "telefone": "+5511999999999",
      "cpf": "***456789**",
      "pontos": 1250,
      "created_at": "2025-06-15T10:30:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 20,
  "total_pages": 1
}

​
Listar Clientes

Retorna a lista de clientes vinculados à sua empresa, com suporte a paginação e busca por nome, email ou telefone.

​
Query Parameters

​
page
integer
default:1
Número da página (começa em 1)
​
per_page
integer
default:20
Quantidade de registros por página (máximo 100)
​
search
string
Texto para buscar por nome, email ou telefone

​
Request

curl -X GET "https://api.indiqai.com/api/v1/public/clients?page=1&per_page=20&search=joao" \
  -H "X-API-Key: indiqai_sua_chave_aqui"

​
Response

{
  "clients": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "nome": "João Silva",
      "email": "joao@email.com",
      "telefone": "+5511999999999",
      "cpf": "***456789**",
      "pontos": 1250,
      "created_at": "2025-06-15T10:30:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 20,
  "total_pages": 1
}

​
Campos da Resposta

​
clients
array
Lista de clientes
​
clients[].id
string
ID único do cliente (UUID)
​
clients[].nome
string
Nome do cliente
​
clients[].email
string
Email do cliente (pode ser null)
​
clients[].telefone
string
Telefone do cliente (pode ser null)
​
clients[].cpf
string
CPF parcialmente mascarado
​
clients[].pontos
integer
Saldo atual de pontos do cliente
​
clients[].created_at
string
Data de cadastro (ISO 8601)
​
total
integer
Total de clientes encontrados
​
page
integer
Página atual
​
per_page
integer
Registros por página
​
total_pages
integer
Total de páginas

Headers

​
X-API-Key
string
required

Chave de API da empresa

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:20
Required range: 1 <= x <= 100
​
search
string | null

Response

Successful Response

​
data
PublicClientResponse · object[]
required
​
page
integer
required
​
pages
integer
required
​
per_page
integer
required
​
total
integer
required