Skip to main content
GET
/
customers
/
list
curl 'https://api.goatpay.com.br/v1/customers/list?page=1&pageSize=20&search=maria&status=Ativo' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Clientes listados",
  "data": {
    "items": [
      {
        "id": "clx_customer",
        "name": "Maria Silva",
        "email": "maria@email.com",
        "document": "123.456.789-01",
        "status": "Ativo",
        "volume": 450.5,
        "transactions": 3
      }
    ],
    "page": 1,
    "pageSize": 20,
    "total": 1,
    "pages": 1
  },
  "requestId": "req_abc"
}
URL: GET https://api.goatpay.com.br/v1/customers/list · Permissão: customers/list
curl 'https://api.goatpay.com.br/v1/customers/list?page=1&pageSize=20&search=maria&status=Ativo' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Clientes listados",
  "data": {
    "items": [
      {
        "id": "clx_customer",
        "name": "Maria Silva",
        "email": "maria@email.com",
        "document": "123.456.789-01",
        "status": "Ativo",
        "volume": 450.5,
        "transactions": 3
      }
    ],
    "page": 1,
    "pageSize": 20,
    "total": 1,
    "pages": 1
  },
  "requestId": "req_abc"
}

​
Query

​
page
number
Página (padrão 1).
​
pageSize
number
Itens por página (padrão 50, máximo 100).
​
search
string
Busca em nome, e-mail ou documento (CPF/CNPJ).
​
status
string
Ativo, Inativo, Bloqueado ou active / inactive / blocked.
Guia: Clientes.

Authorizations

​
X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
pageSize
integer
default:50
Required range: 1 <= x <= 100
​
search
string
Maximum string length: 120
​
status
string

Ativo, Inativo, Bloqueado ou active/inactive/blocked

Response

200 - application/json

Lista paginada (clientes, produtos, cupons ou links).

​
success
boolean
required
​
message
string
required
​
data
object
required
​
requestId
string