SignalWire's Compatibility API is a comprehensive REST API that enables easy management of calls, conferences, messaging, account maintenance, and more.


This API may look very similar to other, existing APIs you've used before — on purpose! The SignalWire Compatible REST API is designed to make migrating your existing phone or messaging application easy and quick, while giving you access to our next generation APIs and endpoints to help you take your application to the next level.

Use our compatible REST APIs to manage resources in your SignalWire space.
Compatible language that you can use to define how your phone numbers react during calls or text messages.
Access the APIs through a compatible SDK available in most major languages.
Find documentation for the deprecated @signalwire/node LaML SDK here.

SignalWire's REST API allows you to manage and modify calls and messages made to or from your SignalWire phone numbers. You also have the ability to retrieve and update your account information, retrieve your entire history of calls, messages, transcriptions, media and more.

This can all be achieved by sending HTTP requests to the SignalWire REST API.

Base URL

Each space on SignalWire gets its own subdomain and each space will have its own URLs for accessing the REST API.

All calls in the provided examples use the following as the base URL:


However, please note that the actual base URL you will use will differ for each space, since it will be customized to include your unique space name. For your own custom URL, replace example with your unique subdomain.

AccountSid vs ProjectID

To support seamless migration and compatibility with other popular providers, the SignalWire Compatible API often refers to the AccountSid. The AccountSid is a unique identifier on other providers. On SignalWire, this is known as the Project ID.

Each project within your space gets its own, unique Project ID and this is used to authenticate requests on the API. This will be the same value as your Project ID but is set as AccountSid for compatibility.

On SignalWire's API, the AccountSid and Project ID are the same thing.