v77

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-08-012528701.8 MB

Addresses

Get Resource Address from a Client

Returns a resource address by ID. This endpoint uses bearer token authentication with a SAT (Subscriber Access Token), which can be generated using the Create Subscriber Token endpoint.

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.

get/api/fabric/addresses/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of a FabricAddress.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

namestring required

Name of the Fabric Address.

display_namestring required

Display name of the Fabric Address.

cover_urlstring required

Cover url of the Fabric Address.

preview_urlstring required

Preview url of the Fabric Address.

lockedboolean required

Locks the Fabric Address. This is used to prevent the Fabric Address from accepting calls.

created_atstring date-time required

Fabric Address Creation Date.

type'app' | 'room' | 'call' | 'subscriber' required

DisplayTypes

Example response

{
  "name": "justice-league",
  "display_name": "Justice League",
  "cover_url": "https://coverurl.com",
  "preview_url": "https://previewurl.com",
  "locked": true,
  "channels": {
    "audio": "/external/resource_name?channel=audio"
  },
  "created_at": "2024-05-06T12:20:00Z"
}