Skip to main content
GET
/
customer-groups
List Customer Groups
curl --request GET \
  --url https://integrations.clopos.com/open-api/customer-groups \
  --header 'x-brand: <api-key>' \
  --header 'x-token: <api-key>' \
  --header 'x-venue: <api-key>'
{
    "success": true,
    "data": [
        {
            "id": 1,
            "name": "My Customers",
            "discount_type": null,
            "discount_value": 0,
            "system_type": "my_customers",
            "created_at": "2025-08-16T15:21:15.000000Z",
            "updated_at": "2025-08-16T15:21:15.000000Z",
            "deleted_at": null
        }
    ],
    "total": 1,
    "time": 71,
    "timestamp": "2025-10-24 05:38:15",
    "sorts": [
        "id",
        "name",
        "discount_type",
        "discount_value",
        "total_amount",
        "created_at",
        "updated_at",
        "deleted_at"
    ],
    "unix": 1761284295
}
This endpoint retrieves a list of all customer groups. 
{
    "success": true,
    "data": [
        {
            "id": 1,
            "name": "My Customers",
            "discount_type": null,
            "discount_value": 0,
            "system_type": "my_customers",
            "created_at": "2025-08-16T15:21:15.000000Z",
            "updated_at": "2025-08-16T15:21:15.000000Z",
            "deleted_at": null
        }
    ],
    "total": 1,
    "time": 71,
    "timestamp": "2025-10-24 05:38:15",
    "sorts": [
        "id",
        "name",
        "discount_type",
        "discount_value",
        "total_amount",
        "created_at",
        "updated_at",
        "deleted_at"
    ],
    "unix": 1761284295
}

​
Customer Group Object

FieldTypeDescription
idintegerThe unique identifier for the customer group.
namestringThe name of the customer group.
discount_typestring | nullThe type of discount associated with the group.
discount_valuenumberThe value of the discount.
system_typestring | nullThe system type of the group (e.g., ‘my_customers’).
created_atstringThe timestamp when the group was created.

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

​
page
integer
default:1

Page number for pagination (starts at 1)

Required range: x >= 1
​
limit
integer
default:50

Number of customer groups to return per page

Required range: 1 <= x <= 200

Response

200 - application/json

Customer groups retrieved successfully.

​
success
boolean
​
data
object[]
​
total
integer
​
time
integer
​
timestamp
string

Server timestamp in local time

​
sorts
string[]
​
unix
integer