Retrieve customerPOST

OpenStock Docs

POST

/api/customer-balance-api/customers/info

customer_balance_api

Looks up one customer by email. The email goes in the JSON body, never in the URL.

Emails in URL paths (for example /customers/{email}) are rejected with deprecated_endpoint. Always send the email in the body.

Authorization#

AuthorizationBearer <token>

In: header. A store API key starting with sk_ that has the customer_balance_api permission.

Request body#

application/json

emailrequiredstring

Customer email address.

Responses#

200The customer.
404No customer with that email in this store.
401Missing, malformed, disabled or expired API key.

curl -X POST "https://openstock.dev/api/customer-balance-api/customers/info" \
  -H "Authorization: Bearer $OPENSTOCK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jane@example.com"
  }'

The customer.

{
  "id": "6f1d3c2a-0b4e-4c8d-9a7f-2e5b1c0d9a8e",
  "email": "jane@example.com",
  "name": "Jane Doe",
  "balance": 25,
  "total_spent": 189.5,
  "order_count": 7,
  "created_at": "2026-01-12T09:30:00.000Z",
  "updated_at": "2026-03-04T18:30:00.000Z"
}