Hosted PBX API: tenants

Use HTTPS and HTTP Basic authentication with approved API credentials. Keep credentials on your application server. These Hosted PBX endpoints use /hpbx/ on api.multitel.net; do not insert /v3. Check both the HTTP result and the application status in the JSON response.

List the account’s PBX tenants

curl --request POST --user "USERNAME:PASSWORD" \
  "https://api.multitel.net/hpbx/tenants/list/0"

The list operation returns the authenticated account’s tenants. The final placeholder segment satisfies the route signature; the list operation does not use it to select another account.

Illustrative list response

{
  "status": {
    "code": "200",
    "msg": "List data"
  },
  "response": [
    {
      "billing_code": "EXAMPLE_BILLING_CODE",
      "isocode": "US",
      "continent_iso": "NA",
      "continent_name": "North America"
    }
  ]
}

Create and change a tenant

Tenant creation is a subscription action and can create setup and recurring charges. Read the available service plans first. Use the current account-authorized reference to select a plan, location and routing profile; do not reuse an example ID as an account selection.

Creation fieldMeaning
hosted_pbx_services_idThe service ID returned for an available plan.
te_rp_idThe approved calling routing profile.
timezoneAn IANA timezone such as America/Detroit.
te_location_idA location ID available to the account, when required.
te_maxextensions / te_maxhunts / te_maxconferences / te_maxvoicemails / te_maxivrsResource capacities constrained by the selected service; they are not arbitrary entitlement overrides.

Review the resulting billing code and provisioned status before configuring extensions. For new integrations and exact mutation schemas, use the current subscription reference.

Search documentation