For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
  • Datasphere
  • Logs
  • Messaging
  • Phone Number Management
  • Platform
      • POSTAssign domain application handler
      • POSTCreate domain application
      • DELDelete domain application
      • GETGet domain application
      • GETList domain applications
      • PUTUpdate domain application
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
PlatformDomain Applications

List domain applications

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/relay/rest/domain_applications
GET
/api/relay/rest/domain_applications
$curl https://{your_space_name}.signalwire.com/api/relay/rest/domain_applications \
>     -u "<project_id>:<api_token>"
1{
2  "links": {
3    "self": "string",
4    "first": "string",
5    "next": "string",
6    "prev": "string"
7  },
8  "data": [
9    {
10      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
11      "type": "domain_application",
12      "domain": "your-space-test_id",
13      "name": "Test App",
14      "identifier": "string",
15      "user": "helpdesk",
16      "ip_auth_enabled": true,
17      "ip_auth": [
18        "string"
19      ],
20      "call_handler": "relay_topic",
21      "calling_handler_resource_id": "fe4093d9-58c2-4931-b4b9-5679f82652c6",
22      "call_relay_topic": "office",
23      "call_relay_topic_status_callback_url": "https://myapplication/handle_relay_callbacks",
24      "call_request_url": "https://example.com/laml",
25      "call_request_method": "GET",
26      "call_fallback_url": "https://example.com/fallback",
27      "call_fallback_method": "GET",
28      "call_status_callback_url": "https://example.com/status",
29      "call_status_callback_method": "GET",
30      "call_laml_application_id": "app-123456",
31      "call_video_room_id": "fe4093d9-58c2-4931-b4b9-5679f82652c6",
32      "call_relay_script_url": "https://example.com/relay-script",
33      "encryption": "required",
34      "codecs": [
35        "string"
36      ],
37      "ciphers": [
38        "string"
39      ],
40      "call_relay_context": "office",
41      "call_relay_context_status_callback_url": "string"
42    }
43  ]
44}
Returns a list of your domain applications. The domain applications are returned sorted by creation date, with the most recent domain applications appearing first. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_, _Messaging_, or _Fax_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
Was this page helpful?
Previous

Update domain application

Next
Built with

Returns a list of your domain applications. The domain applications are returned sorted by creation date, with the most recent domain applications appearing first.

Permissions

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

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) ```

Query parameters

filter_domainstringOptional
String representing the domain portion of the domain application. Will return all domain applications containing this value as a substring.
filter_namestringOptional
String representing the name portion of the domain application. Will return all domain applications containing this value as a substring.
page_numberintegerOptionalDefaults to 0

The page number to retrieve (0-indexed).

page_sizeintegerOptional1-1000Defaults to 50

The number of items per page (1-1000).

page_tokenstringOptional

Token for cursor-based pagination. Required when page_number > 0.

Response

The request has succeeded.
linksobject
Pagination links.
datalist of objects
List of domain applications.

Errors

401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error

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)