User list (minimum)

User list (minimum)

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areausers.json
GeneralYesParameters described in overviewsee overviewStructure of an API call
Model StructureYesName of model requiredmodelstructure=userminimumUsing data models
ActiveNoOption filteractive=Y
FiltersNoFilter by a key fieldFilters

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=userminimum&version=6&active=Y

Example request (legacy username/password):

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

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 282,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "synapiversion": 3.9,
  "data": [
    {
      "userUserId": 568,
      "userInitials": "AAD",
      "userFullName": "Aaron Dyson"
    },
    {
      "userUserId": 499,
      "userInitials": "AC2",
      "userFullName": "Adele Clarke"
    }
  ]
}