Skip to content
Esc
↑↓navigate↵open⌘Jpreview

List accessible phone systems

Returns every phone system the API key currently covers, resolved live from the key’s grant: a single-system key lists its one system, a group key lists the group’s current members, and an organization key lists the organization’s directly-attached systems. Membership changes apply to existing keys without reissue, so call this operation to discover the {phoneSystemId} values usable in resource paths. Requires only a valid tenant API key — no resource scope.

GET/customer/phone-systems
Authorization
X-API-KeyAPI key · headerrequired
API key (sk_phones_* prefix) for programmatic access
Responses
200Phone systems covered by the key, ordered by name.
dataobject[]required
Every phone system the API key currently covers, ordered by name.
Show properties
Array of object
idstring<uuid>required
Phone system identifier — use it as the {phoneSystemId} path segment.
namestringrequired
Display name of the phone system.
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 credential is not a tenant API key: an interactive session token or a platform API key was presented.
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" \
  -H "X-API-Key: YOUR_API_KEY"
Response
{
  "data": [
    {
      "id": "<uuid>",
      "name": "string"
    }
  ]
}