Skip to navigation
Resource ManagementAddresses

Get Resource Address from a Client

View as MarkdownOpen in Claude

Retrieves one resource address visible to the authenticated Subscriber by address ID. Use it when a subscriber client already holds a callable address identifier; use List Resource Addresses from a Client to discover visible addresses. Authenticate with a Subscriber Access Token (SAT), not a project API token.

Resource addresses are callable handles, not standalone SIP Address configurations or physical E911 Addresses.

This operation was previously served at /api/fabric/addresses/{id}. That path still answers SAT-authenticated requests with the same response, and adds a Deprecation: true header and a Link header naming /api/fabric/subscriber/addresses as the successor. No removal date is set. Use /api/fabric/subscriber/addresses/{id} in new code.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

Authentication

AuthorizationBearer

SignalWire Bearer Token Authentication for subscriber endpoints. The client sends HTTP requests with the Authorization header containing the word Bearer followed by a space and the subscriber token.

Example:

Authorization: Bearer <subscriber_token>

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a FabricAddress.

Response

The request has succeeded.
idstringformat: "uuid"
Unique ID of the Fabric Address.
namestring
Name of the Fabric Address.
display_namestring
Display name of the Fabric Address.
typeenum
DisplayTypes
Allowed values:
cover_urlstring or null

Cover URL of the Fabric Address, or null when the resource has no cover image.

preview_urlstring or null

Preview URL of the Fabric Address, or null when no preview is available. Only Conference Room addresses return one, while a session with room previews enabled is in progress.

lockedboolean
Locks the Fabric Address. This is used to prevent the Fabric Address from accepting calls.
channelsobject
Channels of the Fabric Address.
canonical_uristring or null

The address in canonical form: /<context>/<name> for a resource address, sip:<domain> for a SIP address, or the E.164 number for a phone number or WhatsApp number address. null when the phone number, WhatsApp number, or SIP domain behind the address no longer exists.

codecslist of enums or null

Codecs enabled for calls to the address, or null when none are set.

created_atdatetime
Fabric Address Creation Date.

Errors

500
Internal Server Error