Skip to main content
GET
/
customers
/
get
/
{id}
curl 'https://api.goatpay.com.br/v1/customers/get/clx_customer' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Cliente encontrado",
  "data": {
    "id": "clx_customer",
    "name": "Maria Silva",
    "email": "maria@email.com",
    "document": "123.456.789-01",
    "type": "PF",
    "status": "Ativo",
    "transactions": 3,
    "volume": 450.5,
    "createdAt": "2026-05-01T10:00:00.000Z",
    "lastActivityAt": "2026-06-01T18:00:00.000Z"
  },
  "requestId": "req_abc"
}
URL: GET https://api.goatpay.com.br/v1/customers/get/{id} · Permissão: customers/get
curl 'https://api.goatpay.com.br/v1/customers/get/clx_customer' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Cliente encontrado",
  "data": {
    "id": "clx_customer",
    "name": "Maria Silva",
    "email": "maria@email.com",
    "document": "123.456.789-01",
    "type": "PF",
    "status": "Ativo",
    "transactions": 3,
    "volume": 450.5,
    "createdAt": "2026-05-01T10:00:00.000Z",
    "lastActivityAt": "2026-06-01T18:00:00.000Z"
  },
  "requestId": "req_abc"
}

​
Parâmetros

​
id
string
required
ID do cliente (clx_...).
Guia: Clientes.

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string
required

ID do recurso (transação, cobrança, webhook, etc.)

Response

Cliente criado, consultado ou atualizado.

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