Skip to main content
GET
/
users
List Users
curl --request GET \
  --url https://integrations.clopos.com/open-api/users \
  --header 'x-brand: <api-key>' \
  --header 'x-token: <api-key>' \
  --header 'x-venue: <api-key>'
{
  "success": true,
  "data": [
    {
      "id": 123,
      "email": "[email protected]",
      "username": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "status": true,
      "owner": 123,
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 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

Response

200 - application/json

Users retrieved successfully.

success
boolean
data
object[]
total
integer