| 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=userdetails | 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:
http://<SERVER>/jsonapi/users.json?user=user&password=user&style=modeldata&modelstructure=userdetails&version=3.9&active=Y
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 282,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"synapiversion": 3.9,
"data": [
{
"userUuid": "B04659D70256944CA07A04A89ED57DE3",
"userTimestampModified": 1620919119,
"userRecordVersionNumber": 310,
"userUserId": 568,
"userUsername": "Aaron.Dyson",
"userFullName": "Aaron Dyson",
"userInitials": "AAD",
"userEmailAddress": "[email protected]"
},
{
"userUuid": "1FC5C88375476D4288A496D4C05B0C91",
"userTimestampModified": 1618569468,
"userRecordVersionNumber": 140,
"userUserId": 499,
"userUsername": "Adele Clarke",
"userFullName": "Adele Clarke",
"userInitials": "AC2",
"userEmailAddress": ""
},