COcommpeak
Users

Get user

Returns the full record for a single user.

When to use. Fetch one user when you already know their ID. To list all users, use GET /users instead.

Parameters. id (path, required): the ID of the user to fetch.

Returns. { "users": [ { ... } ] } containing the requested user.

Example. GET /api/users/5

get/{sub_domain}/api/users/{id}

Request

  • Base URL
    https://api.commpeak.com/pbx
  • URL
    https://api.commpeak.com/pbx/{sub_domain}/api/users/{id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

User ID.

sub_domainstring required

PBX Name (subdomain)

Response

Successful Response

Example response

{
  "users": [
    {
      "auto_dial": 2,
      "desks": [],
      "email": "test@example.com",
      "first_name": "John",
      "groups": [],
      "id": 1,
      "is_active": 1,
      "is_clockedin": "0000-00-00 00:00:00",
      "is_deleted": 0,
      "is_predictive_clockedin": "0000-00-00 00:00:00",
      "last_name": "Doe",
      "max_concurrent_sessions": 0,
      "max_session_time": 0,
      "member_all_desks": 0,
      "member_all_skill_groups": 0,
      "registration_password": "kh3d5f67g7k8j8f8g8k8fjg",
      "roles": {
        "175": "PBX_ADMIN"
      },
      "sip_option": 2,
      "sip_uri": "user/demo@demo.example.com",
      "skill_groups": [],
      "twofa_type": "default",
      "use_extended_ip_acl": 0,
      "use_webrtc": 0,
      "user_region": 0,
      "username": "demo",
      "virtual_extension": "1000"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.