Purpose: Get users from the particular Organization Unit. 

Request URI/v1.0/organizationunits/{ouIdentifier}/users

Method

GET

ParametersDescription

ouIdentifier *
string

(path)

Could be Guid - internal OU identifier or its Name

includeChild
boolean

(query)

Optional parameter. Default is true.
If you need to get users from only particular Organization unit without child units, pass "false" explicitly.

Default value : true

fieldsToReturn
string

(query)

Comma-separated List of UserDto object fields (first level).

Responses

CodeDescription / Example 
200
[
  {
    "Id": "string",
    "SipUri": "string",
    "FirstName": "string",
    "LastName": "string",
    "OrganizationUnitNodeId": "string",
    "Sid": "string",
    "Sam": "string",
    "Upn": "string",
    "Email": "string",
    "IsSelectable": true,
    "PresenceToken": "string",
    "PresenceState": "string",
    "Capabilities": {
      "Im": true,
      "Audio": true,
      "Video": true,
      "DesktopSharing": true,
      "ConversationContext": true
    },
    "IsBlockedByLuwareApi": true,
    "CurrentProfile": "string",
    "DefaultProfile": "string",
    "NotReadyReason": "string",
    "NotSelectableReason": "string",
    "AAConfiguration": "string",
    "NumberOfSimultaneousIm": 0,
    "ConversationAsService": "NoConversations",
    "IsBusySelectable": true,
    "IsBusyInAMeetingSelectable": true,
    "ShowAwayAsOffline": true,
    "BusyOnBusyInACallEnabled": true,
    "CanLoginToRecordingManager": true,
    "RetargetType": "NoRetarget",
    "RetargetSource": "RedirectPSTNCallsOnly",
    "RetargetTo": "string",
    "RetargetPrivateNumber": true,
    "RetargetOnlyIfInDutyProfile": true,
    "RecordingType": "NoRecording",
    "Traits": [
      {
        "TraitNode": "string",
        "Attribute": "string"
      }
    ],
    "Profiles": [
      {
        "Name": "string",
        "Responsibilities": [
          {
            "TraitNode": "string",
            "Responsibility": "string"
          }
        ]
      }
    ],
    "Roles": [
      {
        "OrganizationUnit": "string",
        "Role": "string",
        "Permission": "Deny"
      }
    ]
  }
]
CODE
500
{
  "Error": {
    "Code": "NotInitialized",
    "Message": "string"
  }
}
CODE