Get PBX Extensions List

This API endpoint will allow you to pull a list of extensions from your PBX along with any associated information.

Base URL #


Example JSON to Get Extensions List #

    "authId": "YOUR_API_ID",
    "authKey": "YOUR_API_KEY",
    "module": "pbx",
    "pbxId": "1234"

POST Parameters #

Parameter Required Description Expected Value
authId Yes Your portal authentication ID string(24)
authKey Yes Your portal authentication key string(24)
module Yes The api module you are accessing. pbx
pbxId Yes The ID of your PBX in the portal. numeric

Example JSON Response #

    "message":"2 total extensions found",
          "email":"[email protected]",
             "address1":"329 S. OYSTER BAY RD",
             "address2":"STE 329",
             "state": "NEW YORK",
          "lastUpdate":"2020-03-01 12:19:01"
          "email":"[email protected]",
          "lastUpdate":"2020-03-01 12:19:01"

JSON Response Parameters #

Parameter Type Description
message string General response message.
count int Total number of extensions returned.
status boolean The status if the request was successful.
node string The ID of the cloud node this was executed on.
executionTime float The time in seconds it took to execute the API request.
result array Contains an array of the returned extensions
result[number] int The PBX extension number.
result[status] boolean Returns true if the extension is registered and false if it is not.
result[firstName] string Extension first name
result[lastName] string Extension last name
result[email] string Extension email address
result[callerId] string Extension’s set outbound caller ID
result[e911] array Returns an array of E911 parameters, this will return a blank array if none set.
result[e911][subscriber] string The E911 subscriber name
result[e911][address1] string The E911 registered address line 1.
result[e911][address2] string The E911 registered address line 2.
result[e911][city] string The E911 registered city.
result[e911][state] string The E911 registered state.
result[e911][zip] string The E911 registered ZIP code.
result[e911][psapName] string The E911 associated PSAP name.
result[lastUpdate] DATETIME The last time the record was automatically updated.