Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB
Customer

Show customer details

Retrieves the customer details, including reward balances.

Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">customer:read</code>

get/customer/{id}

Path parameters

idstring uuid required

Resource Identification

Response

OK

idstring uuid

Unique identifier for the customer.

namestring

Full name of the customer.

emailstring email

Customer's email address.

phonestring

The contact phone number of the customer, excluding the country code indicator.

phone_indicativestring

The country code indicator for the customer's phone number.

fiscal_numberstring

Customer's tax identification number or fiscal number.

keystring

A customizable text field for users to input their own identifier for the customer.

language'PT' | 'EN' | 'ES'

Preferred language for customer communications. Uses ISO 639-1 language codes.

Example response

{
  "id": "649e88cf-0b78-4c36-8f99-33f5ebb812a1",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "phone": "911234567",
  "phone_indicative": "+351",
  "fiscal_number": "PT123456789",
  "key": "customer Key Example",
  "language": "PT",
  "reward_balances": [
    {
      "account_id": "458b2fc4-3092-4de3-abd4-fe1600c09420",
      "available_balance": 12.5
    }
  ]
}