Skip to main content
GET
/
users
/
{id}
Get User by ID
curl --request GET \
  --url https://integrations.clopos.com/open-api/users/{id} \
  --header 'x-brand: <api-key>' \
  --header 'x-token: <api-key>' \
  --header 'x-venue: <api-key>'
{
  "id": 123,
  "email": "[email protected]",
  "username": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "status": true,
  "owner": 123,
  "created_at": "2023-11-07T05:31:56Z"
}

​
HTTP Request

GET https://integrations.clopos.com/open-api/users/{id}

​
Path Parameters

​
id
integer
required
The unique identifier of the user.

​
Request Example

curl --location 'https://integrations.clopos.com/open-api/users/1' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json'

​
Response

{
  "success": true,
  "data": {
    "id": 1,
    "email": "[email protected]",
    "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
  },
  "time": 44,
  "timestamp": "2025-10-16 05:51:18",
  "unix": 1760593878
}

​
Field Reference

​
Response Body

FieldTypeDescription
successbooleanIndicates whether the request completed successfully.
data.idintegerUnique user identifier.
data.emailstring (nullable)Email address associated with the user.
data.usernamestringDisplay name shown in the POS.
data.first_namestring (nullable)First name of the user.
data.last_namestring (nullable)Last name of the user.
data.pinstringPOS PIN code.
data.ownerinteger1 if the user owns the brand, otherwise 0.
data.hideinteger1 if hidden from POS selection, otherwise 0.
data.statusbooleanIndicates whether the user account is active.
data.created_atstringTimestamp when the user was created.
data.updated_atstringTimestamp when the user was last updated.
timestampstringResponse timestamp in YYYY-MM-DD HH:mm:ss format.
unixintegerUnix timestamp of the response.

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

User ID

Response

User retrieved successfully.

​
id
integer
​
email
string<email> | null
​
username
string
​
first_name
string | null
​
last_name
string | null
​
status
boolean
​
owner
integer
​
created_at
string<date-time>