Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Get a phone

Returns customer-safe hardware and extension-assignment detail for one phone.

GET/customer/phone-systems/{phoneSystemId}/phones/{phoneId}
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.
phoneIdstring<uuid>required
Phone identifier from a list response.
Responses
200Customer-safe phone hardware and assignment detail.
brandstring | anyrequired
Show properties
Any of:
string
string
any
any
createdAtstring<date-time>required
When the phone was created.
deviceRolestringrequired
Allowed:deskdect_basedect_handsetspeaker_basespeaker_ringer
extensionobject | anyrequired
Show properties
Any of:
object
idstring<uuid>required
phoneSystemIdstring<uuid>required
typestringrequired
any
any
firmwareVersionstring | anyrequired
Show properties
Any of:
string
string
any
any
idstring<uuid>required
macAddressstring | anyrequired
Show properties
Any of:
string
string
any
any
modelstring | anyrequired
Show properties
Any of:
string
string
any
any
namestringrequired
parentPhoneobject | anyrequired
Show properties
Any of:
object
idstring<uuid>required
phoneSystemIdstring<uuid>required
typestringrequired
any
any
phoneSystemIdstring<uuid>required
slotinteger | anyrequired
Show properties
Any of:
integer
integer
any
any
statusstringrequired
Allowed:activeinactive
updatedAtstring<date-time>required
When the phone record was last updated.
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 phones: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 phone 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.
501Phone inventory is unavailable because encryption is not configured.
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/phones/%3Cuuid%3E" \
  -H "X-API-Key: YOUR_API_KEY"
Response
{
  "brand": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "deviceRole": "desk",
  "extension": {
    "id": "<uuid>",
    "phoneSystemId": "<uuid>",
    "type": "extension"
  },
  "firmwareVersion": "string",
  "id": "<uuid>",
  "macAddress": "string",
  "model": "string",
  "name": "string",
  "parentPhone": {
    "id": "<uuid>",
    "phoneSystemId": "<uuid>",
    "type": "phone"
  },
  "phoneSystemId": "<uuid>",
  "slot": 0,
  "status": "active",
  "updatedAt": "2024-01-01T00:00:00Z"
}