Skip to main content
GET
/
customers
/
{id}
Get Customer by ID
curl --request GET \
  --url https://integrations.clopos.com/open-api/customers/{id} \
  --header 'x-brand: <api-key>' \
  --header 'x-token: <api-key>' \
  --header 'x-venue: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "email": "[email protected]",
  "phone": "<string>",
  "group_id": 123,
  "balance": {
    "id": 123,
    "amount": 123,
    "type": "<string>"
  },
  "cashback_balance": {
    "id": 123,
    "amount": 123,
    "type": "<string>"
  },
  "group": {
    "id": 123,
    "name": "<string>",
    "discount_type": "<string>",
    "discount_value": 123,
    "system_type": "<string>",
    "total_amount": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  },
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-token
string
header
required

Access token obtained from /auth endpoint

x-brand
string
header
required

Brand identifier

x-venue
string
header
required

Venue identifier

Path Parameters

id
integer
required

Customer ID

Response

Customer retrieved successfully.

id
string
name
string
email
string<email>
phone
string
group_id
integer
balance
object
cashback_balance
object
group
object
created_at
string<date-time>