User list

List of users

Example request:

If you wish to access multiple user records you would normally use the userlist model

For more details about using models see Using data models

For users two models are available:

userlist
userdetails

Parameter	Description	Example	More info
API	The API area	users.json
Action	Not required
<General>	Parameters described in overview	user=user&password=user	v3.3 Overview
Modelstructure	Name of model required	Modelstructure=userlist	Using data models
<Filters>	Filter by a key field	uuid=EE096758FAFA3541AA8383834734C739	Filters
Response	Returned data	A JSON string containing the data

Requesting a single user

http://<SERVER>/jsonapi/users.json?user=user&password=user&style=modeldata&modelstructure=userdetails&version=3.3&uuid=EE096758FAFA3541AA8383834734C739

Requesting list of all users

http://<SERVER>/jsonapi/users.json?user=user&password=user&style=modeldata&modelstructure=userdetails&version=3.3

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 239,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "userUuid": "EE096758FAFA3541AA8383834734C739",
      "userTimestampModified": 1539167636,
      "userRecordVersionNumber": 119,
      "userUserId": 239,
      "userUsername": "Aaron.Cook",
      "userFullName": "Aaron Cook",
      "userInitials": "AC",
      "userEmailAddress": ""
    },
    {
      "userUuid": "B04659D70256944CA07A04A89ED57DE3",
      "userTimestampModified": 1556271503,
      "userRecordVersionNumber": 54,
      "userUserId": 568,
      "userUsername": "Aaron.Dean",
      "userFullName": "Aaron Dean",
      "userInitials": "AD",
      "userEmailAddress": "adean@xx_company.co.uk"
    },
    etc. etc.