Sign in
Applications

List Applications

Lists the account's Applications, which provide reusable voice and messaging routing. These applications are also available as addressable cXML Applications in the SignalWire REST API. Use this collection for code built around Application SIDs.

Permissions

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

Learn more about API scopes.

get/Accounts/{AccountSid}/Applications

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The Account ID that has the Application.

Query parameters

FriendlyNamestring

Filter by a named unique identifier for the resource.

Pageinteger

The page number to retrieve. Page numbers are zero-indexed, so the first page is 0.

PageSizeinteger

The number of results to return per page. The default is 50, and the maximum is 1000.

PageTokenstring

A token used to retrieve a specific page of results.

Response

The request has succeeded.

uristring required

The URI for this resource.

first_page_uristring required

The URI for the first page of results.

next_page_uristring nullable required

The URI for the next page of results. Null if there are no more pages.

previous_page_uristring nullable required

The URI for the previous page of results. Null if this is the first page.

pageinteger required

The current page number. Zero-indexed.

page_sizeinteger required

The number of results per page.

Example response

{
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications?Page=0&PageSize=50",
  "first_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications?Page=0&PageSize=50",
  "next_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications?Page=1&PageSize=50",
  "page_size": 50,
  "applications": [
    {
      "api_version": "2010-04-01",
      "date_created": "Sat, 15 Sept 2018 10:00:00 +0000",
      "date_updated": "Sat, 16 Sept 2018 10:00:00 +0000",
      "friendly_name": "My Friendly Name",
      "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications/b3877c40-da60-4998-90ad-b792e98472af.json",
      "voice_url": "http://example.com",
      "voice_method": "POST",
      "voice_fallback_url": "http://example.com",
      "voice_fallback_method": "POST",
      "status_callback": "http://example.com",
      "status_callback_method": "POST",
      "sms_url": "http://example.com",
      "sms_method": "POST",
      "sms_fallback_url": "http://www.example.com/sms-fallback",
      "sms_fallback_method": "POST",
      "sms_status_callback": "http://www.example.com/sms-status-callback",
      "sms_status_callback_method": "POST",
      "message_status_callback": "http://www.example.com/sms-status-callback"
    }
  ]
}

Changes