GET api/v1/users

Get all users in the tenant

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of User
NameDescriptionTypeAdditional information
UserId

Unique ID

integer

None.

FullName

Readable name

string

None.

FirstName

Firstname of the user

string

None.

LastName

Lastname of the user

string

None.

Extension

NetPBX extension number

string

None.

PhoneNumber

External phone number

string

None.

MobileNumber

Mobile number

string

None.

Email

Email address

string

None.

PresentationNumber

External presentation number

string

None.

MEXActive

Mobile extension (MEX) active

boolean

None.

Groups

Groups where user is member Array of unique GroupIds

Collection of integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "UserId": 1,
    "FullName": "sample string 2 sample string 3",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Extension": "sample string 4",
    "PhoneNumber": "sample string 5",
    "MobileNumber": "sample string 6",
    "Email": "sample string 7",
    "PresentationNumber": "sample string 8",
    "MEXActive": true,
    "Groups": [
      1,
      2
    ]
  },
  {
    "UserId": 1,
    "FullName": "sample string 2 sample string 3",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Extension": "sample string 4",
    "PhoneNumber": "sample string 5",
    "MobileNumber": "sample string 6",
    "Email": "sample string 7",
    "PresentationNumber": "sample string 8",
    "MEXActive": true,
    "Groups": [
      1,
      2
    ]
  }
]