v1

latestOpenAPI 3.0.32026-07-24156161.2 MB
User

Get all users

This endpoint makes an HTTP GET request to retrieve a list of users. The response is in JSON format and includes an array of user objects, each containing various attributes such as id, username, email, registration password, and other user-related information.

get/users

Response

Successful operation

Example response

{
  "users": [
    {
      "auto_dial": "2",
      "default_language": null,
      "desks": {
        "1": "Main Desk"
      },
      "email": null,
      "first_name": "",
      "id": "1",
      "is_active": "1",
      "is_deleted": "0",
      "last_name": "",
      "max_concurrent_sessions": "0",
      "max_session_time": "0",
      "member_all_desks": "0",
      "registration_password": "55bdf076b5233e3eced5522a59421cfe",
      "roles": {
        "1": "PBX_ADMIN"
      },
      "sip_option": "0",
      "sip_uri": null,
      "timezone_id": null,
      "twofa_type": "default",
      "use_extended_ip_acl": "0",
      "use_webrtc": "0",
      "username": "system",
      "virtual_extension": "1000"
    },
    {
      "auto_dial": "2",
      "default_language": null,
      "desks": {
        "1": "Main Desk",
        "2": "QA Desk"
      },
      "email": null,
      "first_name": "",
      "id": "2",
      "is_active": "1",
      "is_deleted": "0",
      "last_name": "",
      "max_concurrent_sessions": "0",
      "max_session_time": "0",
      "member_all_desks": "0",
      "registration_password": "55bdf076b5233e3eced5522a59421cfe",
      "roles": {
        "1": "PBX_ADMIN"
      },
      "sip_option": "0",
      "sip_uri": null,
      "timezone_id": null,
      "twofa_type": "default",
      "use_extended_ip_acl": "0",
      "use_webrtc": "0",
      "username": "admin",
      "virtual_extension": "1001"
    }
  ]
}