Sign in
Users

Get All

Get all the users.
Important:
Combination of client_role and client_role_extension defines the user's permission. A wrong combination of these two will cause a validation error, specifying an invalid permission. If client_role_extension is not passed (optional), client_role will refer to the corresponding base permission. To filter on user roles, always pass both the client_role and client_role_extension. Example:

filter={"where": { "client_role": "ROLEVIEWER","client_role_extension": "roleTitle"}}
get/public/api/users?filter={filter}

Query parameters

filterstring

A valid JSON filter object

Headers

Acceptstring

e.g. application/json

Request body

Example request

{
  "Authorization": {
    "Authorization": "Bearer JWT"
  }
}

Response

OK

Example response

{
  "paging": {
    "total": 2,
    "skip": 0,
    "limit": 1000
  },
  "data": [
    {
      "user_id": "53fb03c6546847ee0d30086a",
      "username": "johndoe9@houston.com",
      "first_name": "John",
      "last_name": "Doe",
      "client_role": "ROLEMANAGER",
      "client_role_extension": "Super",
      "email": "johndoe9@houston.com",
      "groups": [
        "test"
      ],
      "language": "en",
      "photo": "https://www.w3schools.com/w3images/avatar2.png",
      "store_id": "5739b18c6b8e2ac941fbee86",
      "tags": [
        "The Dream"
      ],
      "allow_local_login": true,
      "mobile_version": "6.5.16",
      "desktop_version": "7.0.16-9",
      "last_seen": "2020-11-19T14:21:44.625Z",
      "client_ids": [
        "CL1",
        "CL2"
      ],
      "created_date": "2019-02-10T17:20:11.531Z",
      "updated_date": "2020-11-10T12:11:15.439Z"
    },
    {
      "user_id": "53fb03c6546847ee0d33386b",
      "username": "dianedoe9@houston.com",
      "first_name": "Diane",
      "last_name": "Doe",
      "client_role": "ROLEMANAGER",
      "email": "dianedoe9@houston.com",
      "groups": [
        "test"
      ],
      "language": "en",
      "photo": "https://www.w3schools.com/w3images/avatar2.png",
      "store_id": "5739b18c6b8e2ac941fbee87",
      "tags": [
        "The Dream"
      ],
      "allow_local_login": true,
      "terms_of_acceptance_date": "2019-01-23T10:18:32.977Z",
      "weekly_schedule": {
        "mon_hours": {
          "periods": [
            {
              "from": "08:00",
              "to": "20:00"
            }
          ]
        },
        "tue_hours": {
          "periods": [
            {
              "from": "08:00",
              "to": "17:00"
            }
          ]
        },
        "wed_hours": {
          "periods": [
            {
              "from": "08:20",
              "to": "10:00"
            },
            {
              "from": "11:00",
              "to": "16:20"
            }
          ]
        },
        "thu_hours": {
          "periods": [
            {
              "from": "08:00",
              "to": "20:10"
            }
          ]
        },
        "fri_hours": {
          "periods": [
            {
              "from": "08:00",
              "to": "20:05"
            }
          ]
        }
      },
      "created_date": "2018-05-23T04:55:50.862Z",
      "updated_date": "2018-05-23T04:55:50.862Z"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.