Resource type: users
Action Type: Get
Returns a list of users with information about id, user name, first name and last name. With no parameters specified, a list of all users is returned, except for permanently deactivated users.
With parameter userfilter set to onlyOwn an additional response parameter NeuerTerminFuer is added, which contains the user data in an array and is used internally by the app in the appointment module.
Parameters:
userfilter
STRING. User filter. Possible values:ownOfficeGroupOrAll: Returns the active users of the API user’s own office group. If the API user is not assigned to an office group, all active users are returned.onlyOwn: Returns only the API user’s own user record. The response also contains the additional parameterNeuerTerminFuer, if the user setting “NeuerTerminFuer” is set (see response parameterNeuerTerminFuerbelow).byGroupId: Returns all active users of the group specified in parametergroupId.groupIdis mandatory for this value. Group IDs can be retrieved via Get groups.
Note: “Active” means that the user is not deactivated. An active user can still be locked. To identify locked or deactivated users, use the response parameter
online.groupId
INTEGER. Group ID. Required if parameteruserfilteris set tobyGroupId. For all other values ofuserfilter,groupIddoes not need to be set.
Example:
{
"actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
"resourceid": "",
"identifier": "",
"resourcetype": "users",
"parameters": {
"groupId": 225,
"userfilter": "byGroupId"
}
}
Response:
Parameters:
id
INTEGER. User IDusername
STRING. User namefirstname
STRING. First namelastname
STRING. Last nameemail
STRING. Emailmeetingurl
STRING. Meeting URL of the userNeuerTerminFuer
ARRAY. New appointment for. Contains the user data of the user set in the user setting “NeuerTerminFuer”, with the fields listed here. Only returned ifuserfilteris set toonlyOwn.appointmentColor
STRING. Appointment color of the user (Settings > User > Settings > Appointment color)code
STRING. User code (Settings > User > Basic data > User code)online
STRING. Status of the user, see values below. The values are identical to the fieldonlinein Read User.
Values of the field online:
offline: active user, currently not logged inonline: active user, currently logged ingesperrt Falscheingabe Passwort: locked after incorrect password entriespermanent deaktiviert: permanently deactivatedgesperrt Benutzerverwaltung: locked in the user administrationgesperrt Mandantenverwaltung: locked in the client administration
The values are returned in the language of the API user. The values listed above are the German texts.
{
"status": {
"code": 200,
"errorcode": 0,
"message": "OK"
},
"response": {
"results": [
{
"actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
"resourceid": "",
"resourcetype": "users",
"cacheable": true,
"identifier": "",
"data": {
"meta": {
"cntabsolute": null
},
"records": [
{
"id": 25,
"type": null,
"elements": {
"id": 25,
"username": "paulprobe",
"firstname": "Paul",
"lastname": "Probe",
"email": "paulprobe154@onoffice.de",
"meetingurl": "www.meetinglink3178.com",
"appointmentColor": "FFFF00",
"code": "PP",
"online": "online"
}
},
{
"id": 17,
"type": null,
"elements": {
"id": 17,
"username": "theotest",
"firstname": "Theo",
"lastname": "Test",
"email": "theotest154@onoffice.de",
"meetingurl": "www.meetinglink6542.com",
"appointmentColor": "B04F00",
"code": "TT",
"online": "gesperrt Benutzerverwaltung"
}
}
]
},
"status": {
"errorcode": 0,
"message": "OK"
}
}
]
}
}
