Skip to main content
GET
/
customers
List customers
curl --request GET \
  --url https://integrations.clopos.com/open-api/customers \
  --header 'x-brand: <api-key>' \
  --header 'x-token: <api-key>' \
  --header 'x-venue: <api-key>'
{
  "data": [
    {
      "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"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123
  }
}

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

Query Parameters

limit
integer
default:20

Maximum number of customers to return (1-100)

Required range: 1 <= x <= 100

Search customers by name or email

Response

200 - application/json

Customers retrieved successfully

data
object[]
pagination
object