Retrieve an extension

GET/api/v1/domains/{domain_uuid}/extensions/{extension_uuid}

Retrieve the details of one extension.

Path parameters

domain_uuidstringrequired

Your company ID supplied by Junction Cloud Connections. Use the same ID throughout your requests.

extension_uuidstringrequired

The extension UUID.

Responses

200Success

extension_uuidstring

objectstring

domain_uuidstring

extensionstring

enabledboolean

effective_caller_id_namestring

effective_caller_id_numberstring

outbound_caller_id_number_e164string

outbound_caller_id_number_formattedstring

emergency_caller_id_number_e164string

directory_first_namestring

directory_last_namestring

name_formattedstring

directory_visibleboolean

directory_exten_visibleboolean

emailstring

do_not_disturbboolean

user_recordboolean

suspendedboolean

descriptionstring

forward_all_enabledboolean

forward_busy_enabledboolean

forward_no_answer_enabledboolean

forward_user_not_registered_enabledboolean

follow_me_enabledboolean

400Invalid extension UUID

errorobject

Show nested fields

typestring

messagestring

codestring

paramstring

401Unauthenticated

errorobject

Show nested fields

typestring

messagestring

codestring

403The request is not available for this account.

404Extension not found

errorobject

Show nested fields

typestring

messagestring

codestring

paramstring

REQUEST EXAMPLE

Replace the host, token and example IDs with your account details.

curl --request GET \
  --url "https://YOUR-PORTAL-HOST/api/v1/domains/YOUR_COMPANY_UUID/extensions/d2c7b17c-8b0d-4f0f-b5ff-2cfb6d7a4f4b" \
  --header "Authorization: Bearer $JUNCTIONCC_API_TOKEN" \
  --header "Accept: application/json"

const token = process.env.JUNCTIONCC_API_TOKEN;

const response = await fetch("https://YOUR-PORTAL-HOST/api/v1/domains/YOUR_COMPANY_UUID/extensions/d2c7b17c-8b0d-4f0f-b5ff-2cfb6d7a4f4b", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${token}`,
    Accept: "application/json"
  }
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const text = await response.text();
console.log(text ? JSON.parse(text) : null);

import json
import os
from urllib.request import Request, urlopen

request = Request(
    "https://YOUR-PORTAL-HOST/api/v1/domains/YOUR_COMPANY_UUID/extensions/d2c7b17c-8b0d-4f0f-b5ff-2cfb6d7a4f4b",
    method="GET",
    headers={
        "Authorization": "Bearer " + os.environ["JUNCTIONCC_API_TOKEN"],
        "Accept": "application/json"
    }
)
with urlopen(request, timeout=30) as response:
    body = response.read()
    print(json.loads(body) if body else None)

RESPONSE EXAMPLE

{
  "extension_uuid": "d2c7b17c-8b0d-4f0f-b5ff-2cfb6d7a4f4b",
  "object": "extension",
  "domain_uuid": "4018f7a3-8e0a-47bb-9f4f-04b1313e0e1b",
  "extension": "1001",
  "enabled": true,
  "effective_caller_id_name": "Front Desk",
  "effective_caller_id_number": "1001",
  "outbound_caller_id_number_e164": "+12135551212",
  "outbound_caller_id_number_formatted": "(213) 555-1212",
  "emergency_caller_id_number_e164": "+12135559876",
  "directory_first_name": "Front",
  "directory_last_name": "Desk",
  "name_formatted": "Front Desk",
  "directory_visible": true,
  "directory_exten_visible": true,
  "email": "frontdesk@example.com",
  "do_not_disturb": false,
  "user_record": true,
  "suspended": false,
  "description": "Main reception phone",
  "forward_all_enabled": false,
  "forward_busy_enabled": false,
  "forward_no_answer_enabled": false,
  "forward_user_not_registered_enabled": false,
  "follow_me_enabled": false
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "Invalid extension UUID.",
    "code": "invalid_request",
    "param": "extension_uuid"
  }
}

{
  "error": {
    "type": "authentication_error",
    "message": "Unauthenticated.",
    "code": "unauthenticated"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "Extension not found.",
    "code": "resource_missing",
    "param": "extension_uuid"
  }
}