Listar clientes
curl --request GET \
--url https://api.upag.io/v1/customers \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.upag.io/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://api.upag.io/v1/customers';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));Clientes
Listar clientes
Lista os clientes da conta, mais recentes primeiro
GET
https://api.upag.io
/
v1
/
customers
Listar clientes
curl --request GET \
--url https://api.upag.io/v1/customers \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.upag.io/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://api.upag.io/v1/customers';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));Lista os clientes da conta, do mais recente para o mais antigo. Clientes excluídos não aparecem.
Permissão:
Campos em Referência.
customer.read. Apenas chave secreta (sk_…).
Os exemplos usam o sandbox (
https://api.upag.dev/v1). Em produção use https://api.upag.io/v1 com sk_live_….Endpoint
curl -G https://api.upag.dev/v1/customers \
-H "Authorization: Bearer sk_test_your_api_key" \
-d "page=1" \
-d "limit=15"
import { Upag } from 'upag';
const upag = new Upag('sk_test_your_api_key');
const { data, count } = await upag.customers.list({ page: 1, limit: 15 });
Parâmetros
integer
default:"1"
Página, a partir de 1.
integer
default:"15"
Itens por página, mínimo 1.
Resposta
200 OK. count é o total de clientes da conta.
Response
{
"data": [
{
"id": "8c1f0a26-5d3b-4f1e-9c72-1a4e6b9d0f83",
"name": "Maria Souza",
"email": "maria@example.com",
"document": { "number": "12345678909", "type": "cpf" },
"phone": { "countryCode": "55", "areaCode": "11", "number": "999998888" },
"address": {
"street": "Avenida Paulista",
"number": "1578",
"complement": null,
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"country": "BR",
"zip": "01310200"
},
"createdAt": "2026-07-27T18:04:11.482Z",
"updatedAt": "2026-07-27T18:04:11.482Z"
}
],
"count": 1
}