Get users

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.

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 users of the API user’s own office group. If the API user is not assigned to an office group, all users are returned.
  • onlyOwn: Returns only the API user’s own user record. The response also contains the additional parameter NeuerTerminFuer (see below).
  • byGroupId: Returns all users of the group specified in parameter groupId. groupId is mandatory for this value. Group IDs can be retrieved via Get groups.
• groupId
  INTEGER. Group ID. Required if parameter userfilter is set to byGroupId. For all other values of userfilter, groupId does 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 ID
• username
  STRING. User name
• firstname
  STRING. First name
• lastname
  STRING. Last name
• email
  STRING. Email
• meetingurl
  STRING. Meeting URL of the user
• NeuerTerminFuer
  ARRAY. New appointment for
• appointmentColor
  STRING. Appointment color of the user (Settings > User > Settings > Appointment color)
• code
  STRING. User code (Settings > User > Basic data > User code)

{
    "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"
                            }
                        },
                        {
                            "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"
                            }
                        }
                    ]
                },
                "status": {
                    "errorcode": 0,
                    "message": "OK"
                }
            }
        ]
    }
}