Skip to navigation
Resource ManagementRelay Application

List Relay application Addresses

View as MarkdownOpen in Claude

Returns the project-scoped resource addresses assigned to one Relay Application. Use these callable handles to see how calls or messages can reach the Relay Server SDK topic; use List Relay applications for the resources themselves, or the address operation for the handler type you actually use.

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

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

Path parameters

idstringRequiredformat: "uuid"
The unique identifier of the Relay Application.

Response

The request has succeeded.
datalist of objects
An array of objects that contain a list of Relay Application Addresses

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error