User list (minimum)

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areausers.json
GeneralYesParameters described in overviewuser=user&password=user&version=3.8v3.8 Overview
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:

http://<SERVER>/jsonapi/users.json?user=user&password=user&style=modeldata&modelstructure=userminimum&version=3.8&active=Y

Example response:

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