GET /api/users, parameters:

PARAMS KEY MANDATORY TYPE Description Example
realm yes string Client unique domain office.modulis.clusterpbx.ca

Result example:

JSON – output

[
    {
        "id": 6439,
        "first_name": "Jane",
        "last_name": "Doe",
        "email": "test@test.com",
        "vm_new_message": null,
        "vm_old_message": null,
        "vm_saved_message": null,
        "profile_name": "Client's employee on new gateway (no rec)",
        "realm_id": 761,
        "language": "fr",
        "department_id": null,
        "profile_id": 161,
        "session_token": "T9soF7k3yCHyGRpdWc2v7w",
        "exclude_from_directory": false,
        "realm": "test.modulis.clusterpbx.ca",
        "dnd_status": "0",
        "forward_status": null,
        "followmeprompt": null,
        "followme_delay": null,
        "enable_call_panel": null,
        "followme_timeout": null,
        "followme_status": "",
        "callwaiting_status": "1",
        "clid_name_external": null,
        "clid_num_external": null,
        "username": null,
        "model": 4,
        "prov_tmpl": 507,
        "status": true,
        "subscriber": "111",
        "vm_email": "test@test.com",
        "mac": "0004f21748b2",
        "vm_box": "111",
        "buttons": [
            {
                "button_id": 1,
                "action_id": 0,
                "value": "111"
            },
            {
                "button_id": 2,
                "action_id": 0,
                "value": "111"
            },
            {
                "button_id": 3,
                "action_id": 3,
                "value": null
            }
        ],
        "expansion_pack_buttons": [],
        "macs": [
            {
                "mac": {
                    "created_at": "2016-03-29T12:29:48-04:00",
                    "deleted_at": null,
                    "device_model_id": 4,
                    "id": 3479,
                    "mac": "0004f21748b2",
                    "provisioning_template_id": 507,
                    "sccp_addon": "",
                    "updated_at": "2017-02-21T10:59:57-05:00"
                },
                "mac_clone": {
                    "created_at": "2016-03-29T12:29:48-04:00",
                    "deleted_at": null,
                    "device_model_id": 4,
                    "id": 3479,
                    "mac": "0004f21748b2",
                    "provisioning_template_id": 507,
                    "sccp_addon": "",
                    "updated_at": "2017-02-21T10:59:57-05:00"
                }
            }
        ],
        "provisioning_urls": [
            "0004f21748b2-reg.cfg"
        ],
        "device_model": "IP301/IP321/IP330/IP331/IP335",
        "device_vendor": "Polycom",
        "language_name": "French",
        "custom_prov_tmpl": null,
        "disallow_clid_override": "0",
        "disabled_directmedia": 0,
        "is_direct_media_enable": false,
        "is_voicemailbox_enabled": true,
        "voicemail_destination": "",
        "email_vm_to_email": "test@test.com",
        "attach": "yes",
        "custom_deletevoicemail": "no",
        "pagerdest": "",
        "web_email_as_vm_to_email": "no",
        "multiple_vm_to_watch": ""
    },
    ...
]

Example: