curl -X GET 'https://api.goatpay.com.br/v1/customers/list' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Clientes listados",
"data": {
"items": [{
"id": "clx_customer",
"name": "Cliente Exemplo",
"email": "cliente@email.com",
"whatsapp": "11999999999",
"phone": "11999999999",
"document": "123.456.789-09",
"city": "São Paulo",
"state": "SP",
"type": "PF",
"status": "Ativo",
"createdAt": "2026-07-01T12:00:00.000Z",
"lastActivityAt": "2026-07-04T10:00:00.000Z",
"transactions": 5,
"volume": 499.5
}],
"page": 1,
"pageSize": 50,
"total": 1,
"pages": 1,
"summary": {
"totalCustomers": 1,
"activeCustomers": 1,
"totalTransactions": 5,
"totalVolume": 499.5
}
},
"requestId": "req_abc"
}
Clientes
Listar clientes
Lista clientes de cobrança da conta.
GET
/
customers
/
list
curl -X GET 'https://api.goatpay.com.br/v1/customers/list' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Clientes listados",
"data": {
"items": [{
"id": "clx_customer",
"name": "Cliente Exemplo",
"email": "cliente@email.com",
"whatsapp": "11999999999",
"phone": "11999999999",
"document": "123.456.789-09",
"city": "São Paulo",
"state": "SP",
"type": "PF",
"status": "Ativo",
"createdAt": "2026-07-01T12:00:00.000Z",
"lastActivityAt": "2026-07-04T10:00:00.000Z",
"transactions": 5,
"volume": 499.5
}],
"page": 1,
"pageSize": 50,
"total": 1,
"pages": 1,
"summary": {
"totalCustomers": 1,
"activeCustomers": 1,
"totalTransactions": 5,
"totalVolume": 499.5
}
},
"requestId": "req_abc"
}
curl -X GET 'https://api.goatpay.com.br/v1/customers/list' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Clientes listados",
"data": {
"items": [{
"id": "clx_customer",
"name": "Cliente Exemplo",
"email": "cliente@email.com",
"whatsapp": "11999999999",
"phone": "11999999999",
"document": "123.456.789-09",
"city": "São Paulo",
"state": "SP",
"type": "PF",
"status": "Ativo",
"createdAt": "2026-07-01T12:00:00.000Z",
"lastActivityAt": "2026-07-04T10:00:00.000Z",
"transactions": 5,
"volume": 499.5
}],
"page": 1,
"pageSize": 50,
"total": 1,
"pages": 1,
"summary": {
"totalCustomers": 1,
"activeCustomers": 1,
"totalTransactions": 5,
"totalVolume": 499.5
}
},
"requestId": "req_abc"
}
Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Query Parameters
Required range:
x >= 1Required range:
1 <= x <= 100Maximum string length:
120Ativo, Inativo, Bloqueado ou active/inactive/blocked

