List Users


This request returns a list of users.

Resource

GET /users[?parameters]

Parameters

Name Type Description

where

[String]

Additional search fields. The field userName is supported: where=userName=[name]

include

[String]
seperate by comma if you want to include multiple fields

Include fields to the result. include=[included fields]
person → person object
-active → is person active
-userName → the username
-userLicense → is licensed
-xccRole → the user role
-loginDate → user login date
-logoutDate → user logout date
-primaryLine → the user primary line
-primaryLine.autoAttendantOn → is auto attendand on
-primaryLine.answerWithMusicOnHold → queue music
-primaryLine.defaultFallback → default fallback line
-primaryLine.associatedAddressable → the associated addressable
-primaryLine.dayNightMode.enableDayNightMode → is day night mode enabled
-primaryLine.dayNightMode.manualNightMode → manual night mode line
-primaryLine.userPhoneLine.redirectionActive → is redirection enabled
-primaryLine.userPhoneLine.redirection → redirection number
-primaryLine.userPhoneLine.doNotDisturb → is do not disturb enabled
-primaryLine.userPhoneLine.voicemailActive → is voicemail active
-primaryLine.userPhoneLine.fallbackActive → is fallback active
-primaryLine.userPhoneLine.fallback → fallback line
-primaryLine.phones → phones of the line
-primaryLine.phones.phone.active → is phone active
-primaryLine.phones.phone.doNotDisturb → is phone on do not disturb
-primaryLine.phones.phone.user → the phone user
-primaryLine.phones.phone.users → phone softphone users
-primaryLine.phones.phone.isRegistered → phone softphone users
-primaryLine.phones.phone.phoneNumber → smartphone number
-primaryLine.extensions → phone line extensions
-lines → lines of the user (including incoming, outgoing, editable, …​)
-lines.line.associatedAddressable → associated addressable of the line
-lines.line.autoAttendant → is auto attendand on
-lines.line.answerWithMusicOnHold → queue music
-lines.line.defaultFallback → default fallback line
-lines.line.dayNightMode.enableDayNightMode → is day night mode enabled
-lines.line.dayNightMode.manualNightMode → manual night mode line
-lines.line.userPhoneLine.redirectionActive → is redirection enabled
-lines.line.userPhoneLine.redirection → redirection number
-lines.line.userPhoneLine.doNotDisturb → is do not disturb enabled
-lines.line.userPhoneLine.voicemailActive → is voicemail active
-lines.line.userPhoneLine.fallbackActive → is fallback active
-lines.line.userPhoneLine.fallback → fallback line
-mangedLines → lines of which the user is a manager (including incoming, outgoing, editable, …​)
-mangedLines.phoneLine.associatedAddressable → associated addressable of the line
-mangedLines.phoneLine.autoAttendant → is auto attendant on
-mangedLines.phoneLine.answerWithMusicOnHold → queue music
-mangedLines.phoneLine.defaultFallback → default fallback line
-mangedLines.phoneLine.dayNightMode.enableDayNightMode → is day night mode enabled
-mangedLines.phoneLine.dayNightMode.manualNightMode → manual night mode line
-mangedLines.phoneLine.userPhoneLine.redirectionActive → is redirection enabled
-mangedLines.phoneLine.userPhoneLine.redirection → redirection number
-mangedLines.phoneLine.userPhoneLine.doNotDisturb → is do not disturb enabled
-mangedLines.phoneLine.userPhoneLine.voicemailActive → is voicemail active
-mangedLines.phoneLine.userPhoneLine.fallbackActive → is fallback active
-mangedLines.phoneLine.userPhoneLine.fallback → fallback line

Payload

None

Response

Context

Authorization

User

Errors

Example

Request
GET https://xelion.nl/api/v1/master/users
Response
{
  "data": [
    {
      "object": {
        "commonName": "user",
        "oid": "1033697",
        "objectType": "UserProfile"
      },
      "links": [
        {
          "rel": "self",
          "href": "http://www.xelion.nl/api/v1/master/users/1033697",
          "method": "GET"
        }
      ]
    }
  ],
  "meta": {
    "links": [
      {
        "rel": "refresh",
        "href": "http://www.xelion.nl/api/v1/master/users",
        "method": "GET"
      },
      {
        "rel": "next",
        "href": "http://www.xelion.nl/api/v1/master/users?after=1033697",
        "method": "GET"
      },
      {
        "rel": "previous",
        "href": "http://www.xelion.nl/api/v1/master/users?before=1033697",
        "method": "GET"
      }
    ],
    "paging": {
      "previousId": "1033697",
      "nextId": "1033697"
    }
  }
}