User list

Parameter	Mandatory	Description	Examples	More Info
API	Yes	The API area	users.json
General	Yes	Parameters described in overview	see overview	Structure of an API call
Model Structure	Yes	Name of model required	modelstructure=userslist	Using data models
Active	No	Option filter	active=Y
Filters	No	Filter by a key field		Filters

Get a single user by passing UUID in filters. Eg: uuid=EE096758FAFA3541AA8383834734C739

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://&lt;SERVER&gt;/jsonapi/users.json?&style=modeldata&modelstructure=userslist&version=6&active=Y

Example request (legacy username/password):

http://&lt;SERVER&gt;/jsonapi/users.json?&style=modeldata&modelstructure=userslist&version=6&active=Y&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 274,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "synapiversion": 3.9,
  "data": [
    {
      "userUuid": "B04659D70256944CA07A04A89ED57DE3",
      "userTimestampModified": 1611337444,
      "userRecordVersionNumber": 117,
      "userUserId": 568,
      "userUsername": "Aaron.Dyson"
    },
    {
      "userUuid": "1FC5C88375476D4288A496D4C05B0C91",
      "userTimestampModified": 1578916074,
      "userRecordVersionNumber": 108,
      "userUserId": 499,
      "userUsername": "Adele Clarke"
    }
  ]
}