Skip to main content
GET
/
customers
/
get
Buscar um cliente
curl --request GET \
  --url https://api.abacatepay.com/v2/customers/get \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "cust_aebxkhDZNaMmJeKsy0AHS0FQ",
    "devMode": true,
    "name": "Daniel Lima",
    "cellphone": "(11) 4002-8922",
    "email": "daniel_lima@abacatepay.com",
    "taxId": "123.456.789-01",
    "country": "BR",
    "zipCode": "01310-100",
    "metadata": {
      "source": "landing-page",
      "campaign": "black-friday-2025"
    }
  },
  "error": null,
  "success": true
}
Retorna os dados de um cliente pelo seu id.

Requer a permissão CUSTOMER:READ.
Use para recuperar o id de um cliente antes de criar uma cobrança ou para verificar os dados cadastrados.

Authorizations

​
Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Query Parameters

​
id
string

Identificador único público do cliente

Example:

"cust_aebxkhDZNaMmJeKsy0AHS0FQ"

Response

Cliente encontrado com sucesso.

​
data
object

Os dados do seu cliente.

​
error
string | null
Example:

null

​
success
boolean

Se a requisição obteve sucesso ou não.

Example:

true