curl --request GET \
--url https://{host}/api/v1/extensions/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/api/v1/extensions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/api/v1/extensions/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"enabled": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": "<string>",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"caller_id_name": "<string>",
"caller_id_number": "<string>",
"codec_profile": "standard",
"codec_string": "<string>",
"default_region": "<string>",
"has_pin": true,
"login_team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"record_calls": true,
"voicemail_email": "<string>",
"voicemail_enabled": true,
"voicemail_sms": "<string>"
}One extension
curl --request GET \
--url https://{host}/api/v1/extensions/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/api/v1/extensions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/api/v1/extensions/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"enabled": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": "<string>",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"caller_id_name": "<string>",
"caller_id_number": "<string>",
"codec_profile": "standard",
"codec_string": "<string>",
"default_region": "<string>",
"has_pin": true,
"login_team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"record_calls": true,
"voicemail_email": "<string>",
"voicemail_enabled": true,
"voicemail_sms": "<string>"
}Authorizations
Every request sends Authorization: Bearer <token>. The token is either a panel session (a JWT from /auth/login, 12 hours) or an API key ft_<id>_<secret>. An API key is accepted only from an address on its IP allowlist (403 ip_not_allowed otherwise; 403 ip_allowlist_required for an old key that has none), is limited to its rate per minute (429 rate_limited with Retry-After; X-RateLimit-Limit/Remaining/Reset on every response), and at most 60 call placements a minute.
Path Parameters
Response
The extension.
The SIP password is deliberately absent: it is returned once at creation and never readable afterwards.
standard, low_bandwidth, g711_ulaw, g711_alaw, opus_8k, opus_16k, opus_32k, g729, ilbc, g726 The extension's own codec list, in order, comma-separated from the catalogue (PCMA,PCMU,G729), as a trunk's codec_string. Empty: the codec profile decides. When set it is exactly what the phone is offered, and every call from or to the extension is steered from it.
Overrides the organisation's dial-from country for this extension. Empty inherits it. ISO-3166 alpha-2.
Whether this agent can sign in to the Desk. The PIN belongs to the agent and IS the login (migration 0061): there is no separate panel user to create first. Never the PIN itself and never a hash.
The team the agent's sign-in is scoped to when they are on more than one. Null means the one team they are on.
Switches call recording on at this level. It cannot switch recording off: a call is recorded if ANY of its organisation, team, extension, queue, trunk or process has this set.
Where a new message in this extension's mailbox is emailed, the recording attached (10 MB or less). Empty sends nothing.
A call nobody answers goes to this extension's mailbox.
The mobile (E.164) a new voicemail is texted to: who, how long, and where to listen. Empty sends nothing.