Gets a list of calendar users.
Users List
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | calendar.json | |
| General | Yes | Parameters described in overview | Authorization: Bearer <access_token> header — see Synergist API Authentication | Structure of an API call |
| Company | Yes | The company number | company=1 | |
| Action | Yes | The action to perform | action=users |
Example request (OAuth 2.0):
Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/calendar.json?&version=6&action=users&company=1
Example request (legacy username/password):
http://<SERVER>/jsonapi/calendar.json?&version=6&action=users&company=1&user=<username>&password=<password>
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 60,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"userUuid": "80007A6A673B434A8B455A30A31909CC",
"userTimestampModified": 1499858513,
"userRecordVersionNumber": 201,
"userFullName": "Alan Greenwood",
"userUserId": 67,
"calUserFullNameTZ": "Alan Greenwood",
"calUserNonWorkingDaysWeek": "YNNNNNY",
"calUserAvatarUrl": "/web/images/avatar-blank-192.png",
"calUserTeamName": ""
},
{
"userUuid": "85E7C3A1EA0211E2897100155D003435",
"userTimestampModified": 1499858514,
"userRecordVersionNumber": 183,
"userFullName": "Barabara Nimble",
"userUserId": 96,
"calUserFullNameTZ": "Barabara Nimble",
"calUserNonWorkingDaysWeek": "YNNNNNY",
"calUserAvatarUrl": "/web/images/avatar-blank-192.png",
"calUserTeamName": ""
}
]
}