Sign in

v1

latestOpenAPI 3.0.32026-07-24156161.2 MB
User

Get user

Get User Details

This endpoint retrieves the details of a specific user based on the provided user ID.

Response

The response will contain an array of user objects, with each object including the following properties:

  • id (string): The unique identifier of the user.

  • username (string): The username of the user.

  • email (string): The email address of the user.

  • registration_password (string): The registration password of the user.

  • is_active (string): Indicates whether the user is active.

  • is_clockedin (string): Indicates whether the user is clocked in.

  • sip_uri (string): The SIP URI of the user.

  • auto_dial (string): Indicates the auto-dial status of the user.

  • is_deleted (string): Indicates whether the user is deleted.

  • use_extended_ip_acl (string): Indicates the usage of extended IP ACL.

  • timezone_id (string): The timezone ID of the user.

  • use_webrtc (string): Indicates the usage of WebRTC.

  • first_name (string): The first name of the user.

  • last_name (string): The last name of the user.

  • virtual_extension (string): The virtual extension of the user.

  • default_language (string): The default language of the user.

  • max_session_time (string): The maximum session time allowed for the user.

  • max_concurrent_sessions (string): The maximum concurrent sessions allowed for the user.

  • twofa_type (string): The two-factor authentication type of the user.

  • member_all_desks (string): Indicates whether the user is a member of all desks.

  • desks (array): An array of desks associated with the user.

  • roles (object): An object containing the roles assigned to the user.

  • groups (array): An array of groups associated with the user.

get/users/{id}

Response

Successful operation

Example response

{
  "users": [
    {
      "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"
    }
  ]
}