Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Get an extension

Returns phone assignments and directly configured unanswered routing for one extension.

GET/customer/phone-systems/{phoneSystemId}/extensions/{extensionId}
Authorization
X-API-KeyAPI key · headerrequired
API key (sk_phones_* prefix) for programmatic access
Path parameters
phoneSystemIdstring<uuid>required
Phone system identifier, discoverable via the accessible phone systems operation.
extensionIdstring<uuid>required
Extension identifier from a list response or typed reference.
Responses
200Extension assignments and directly configured unanswered routing.
createdAtstring<date-time>required
When the extension was created.
idstring<uuid>required
namestringrequired
numberstringrequired
phoneSystemIdstring<uuid>required
phonesobject[]required
Show properties
Array of object
idstring<uuid>required
phoneSystemIdstring<uuid>required
typestringrequired
statusstringrequired
Allowed:activeinactive
unansweredCallBehaviorobjectrequired
Show properties
businessHoursobject | anyrequired
Show properties
Any of:
object
Any of:
object
idstring<uuid>required
phoneSystemIdstring<uuid>required
typestringrequired
Allowed:extensionagent-configcall-groupcall-menu
object
idstring<uuid>required
phoneSystemIdstring<uuid>required
typestringrequired
Allowed:extension-voicemailcall-group-voicemail
object
Any of:
object
playbackUrlstring<uri> | anyrequired
Show properties
Any of:
string<uri>
string<uri>
any
any
typestringrequired
object
phoneNumberstring<phone-number>required
E.164 phone number, including the leading + and international country code.
typestringrequired
object
typestringrequired
object
typestringrequired
object
typestringrequired
object
typestringrequired
object
typestringrequired
object
typestringrequired
object
typestringrequired
any
any
offHoursobject | anyrequired
Show properties
Any of:
object
Any of:
object
idstring<uuid>required
phoneSystemIdstring<uuid>required
typestringrequired
Allowed:extensionagent-configcall-groupcall-menu
object
idstring<uuid>required
phoneSystemIdstring<uuid>required
typestringrequired
Allowed:extension-voicemailcall-group-voicemail
object
Any of:
object
playbackUrlstring<uri> | anyrequired
Show properties
Any of:
string<uri>
string<uri>
any
any
typestringrequired
object
phoneNumberstring<phone-number>required
E.164 phone number, including the leading + and international country code.
typestringrequired
object
typestringrequired
object
typestringrequired
object
typestringrequired
object
typestringrequired
object
typestringrequired
object
typestringrequired
object
typestringrequired
any
any
timeoutSecondsintegerrequired
min 0
updatedAtstring<date-time>required
When the extension record was last updated.
voicemailGreetingPlaybackUrlstring<uri> | anyrequired
Show properties
Any of:
string<uri>
string<uri>
any
any
400A path identifier is invalid.
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
401The API key is missing, malformed, expired, or revoked.
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
403The key lacks the extensions:read scope, or is not a tenant API key.
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
404The extension or phone system does not exist within the key grant.
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
Request
curl -X GET "https://api.steerphones.com/v1/customer/phone-systems/%3Cuuid%3E/extensions/%3Cuuid%3E" \
  -H "X-API-Key: YOUR_API_KEY"
Response
{
  "createdAt": "2024-01-01T00:00:00Z",
  "id": "<uuid>",
  "name": "string",
  "number": "string",
  "phoneSystemId": "<uuid>",
  "phones": [
    {
      "id": "<uuid>",
      "phoneSystemId": "<uuid>",
      "type": "phone"
    }
  ],
  "status": "active",
  "unansweredCallBehavior": {
    "businessHours": {
      "id": "<uuid>",
      "phoneSystemId": "<uuid>",
      "type": "extension"
    },
    "offHours": {
      "id": "<uuid>",
      "phoneSystemId": "<uuid>",
      "type": "extension"
    },
    "timeoutSeconds": 0
  },
  "updatedAt": "2024-01-01T00:00:00Z",
  "voicemailGreetingPlaybackUrl": "<uri>"
}