Skip to navigation

List Relay applications

View as MarkdownOpen in Claude

Returns the project’s Relay Application resources, which route calls or messages to a Relay Server SDK application listening on a topic. Use it to discover topic-backed handlers before retrieving or changing one. Use a SWML Webhook for an HTTP server that returns instructions per request, or a Call Flow for a visual handler.

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)

Response

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

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error