HTTP Request
GET https://integrations.clopos.com/open-api/v2/users
Request Example
curl --location 'https://integrations.clopos.com/open-api/v2/users' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json'
const response = await fetch('https://integrations.clopos.com/open-api/v2/users', {
headers: {
'Content-Type': 'application/json',
Accept: 'application/json'
}
});
import requests
url = 'https://integrations.clopos.com/open-api/v2/users'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.get(url, headers=headers)
print(response.json())
Response
{
"success": true,
"data": [
{
"id": 1,
"email": "openapitest@clopos.com",
"username": "Open Api Test",
"first_name": "Open Api",
"last_name": "Test",
"pin": "0000",
"card": null,
"mobile_number": null,
"owner": 1,
"hide": 1,
"salary": null,
"barcode": null,
"tip_message": null,
"can_receive_tips": false,
"login_at": null,
"status": true,
"bonus_balance_id": null,
"created_at": "2025-08-16T15:21:15.000000Z",
"updated_at": "2025-08-16T15:21:15.000000Z",
"deleted_at": null,
"properties": [],
"image": null
},
{
"id": 3,
"email": null,
"username": "Cashier",
"first_name": null,
"last_name": null,
"pin": "8312",
"card": null,
"mobile_number": null,
"owner": 0,
"hide": 0,
"salary": null,
"barcode": null,
"tip_message": null,
"can_receive_tips": false,
"login_at": null,
"status": true,
"bonus_balance_id": null,
"created_at": "2025-08-16T15:21:15.000000Z",
"updated_at": "2025-08-16T15:21:15.000000Z",
"deleted_at": null,
"properties": [],
"image": null
}
],
"total": 2,
"time": 51,
"timestamp": "2025-10-16 05:49:50",
"sorts": [
"id",
"email",
"username",
"first_name",
"last_name",
"pin",
"card",
"owner",
"hide",
"salary",
"login_at",
"created_at",
"deleted_at",
"total_service_charge",
"total_cash",
"total_receipt",
"total_guests"
],
"unix": 1760593790
}
Field Reference
Response Body
| Field | Type | Description |
|---|---|---|
success | boolean | Indicates whether the request completed successfully. |
data | array | Array of user records. |
data[].id | integer | Unique user identifier. |
data[].email | string (nullable) | Email address associated with the user. |
data[].username | string | Display name shown in the POS. |
data[].first_name | string (nullable) | First name of the user. |
data[].last_name | string (nullable) | Last name of the user. |
data[].pin | string | POS PIN code. |
data[].owner | integer | 1 if the user owns the brand, otherwise 0. |
data[].hide | integer | 1 if hidden from POS selection, otherwise 0. |
data[].status | boolean | Indicates whether the user account is active. |
data[].created_at | string | Timestamp when the user was created. |
data[].updated_at | string | Timestamp when the user was last updated. |
total | integer | Total number of users returned. |
timestamp | string | Response timestamp in YYYY-MM-DD HH:mm:ss format. |
unix | integer | Unix timestamp of the response. |
sorts | array | List of sortable fields. |