# List cXML Applications

GET https://%7BYour_Space_Name%7D.signalwire.com/api/fabric/resources/cxml_applications

A list of cXML Applications

#### 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](/docs/platform/your-signalwire-api-space).

Reference: https://signalwire.com/docs/apis/fabric/cxml-applications/list-cxml-applications

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: fabric
  version: 1.0.0
paths:
  /resources/cxml_applications:
    get:
      operationId: list-cxml-applications
      summary: List cXML Applications
      description: >-
        A list of cXML Applications


        #### 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](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_cxmlApplications
      parameters:
        - name: Authorization
          in: header
          description: >-
            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)

            ```
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CxmlApplicationListResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
servers:
  - url: https://%7BYour_Space_Name%7D.signalwire.com/api/fabric
components:
  schemas:
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    CxmlApplicationResponseType:
      type: string
      enum:
        - cxml_application
      description: Type of the Fabric Resource
      title: CxmlApplicationResponseType
    CxmlApplicationVoiceMethod0:
      type: string
      enum:
        - GET
      title: CxmlApplicationVoiceMethod0
    CxmlApplicationVoiceMethod1:
      type: string
      enum:
        - POST
      title: CxmlApplicationVoiceMethod1
    CxmlApplicationVoiceMethod:
      oneOf:
        - $ref: '#/components/schemas/CxmlApplicationVoiceMethod0'
        - $ref: '#/components/schemas/CxmlApplicationVoiceMethod1'
      description: HTTP method for voice URL
      title: CxmlApplicationVoiceMethod
    CxmlApplicationVoiceFallbackMethod0:
      type: string
      enum:
        - GET
      title: CxmlApplicationVoiceFallbackMethod0
    CxmlApplicationVoiceFallbackMethod1:
      type: string
      enum:
        - POST
      title: CxmlApplicationVoiceFallbackMethod1
    CxmlApplicationVoiceFallbackMethod:
      oneOf:
        - $ref: '#/components/schemas/CxmlApplicationVoiceFallbackMethod0'
        - $ref: '#/components/schemas/CxmlApplicationVoiceFallbackMethod1'
      description: HTTP method for voice fallback URL
      title: CxmlApplicationVoiceFallbackMethod
    CxmlApplicationStatusCallbackMethod0:
      type: string
      enum:
        - GET
      title: CxmlApplicationStatusCallbackMethod0
    CxmlApplicationStatusCallbackMethod1:
      type: string
      enum:
        - POST
      title: CxmlApplicationStatusCallbackMethod1
    CxmlApplicationStatusCallbackMethod:
      oneOf:
        - $ref: '#/components/schemas/CxmlApplicationStatusCallbackMethod0'
        - $ref: '#/components/schemas/CxmlApplicationStatusCallbackMethod1'
      description: HTTP method for status callbacks
      title: CxmlApplicationStatusCallbackMethod
    CxmlApplicationSmsMethod0:
      type: string
      enum:
        - GET
      title: CxmlApplicationSmsMethod0
    CxmlApplicationSmsMethod1:
      type: string
      enum:
        - POST
      title: CxmlApplicationSmsMethod1
    CxmlApplicationSmsMethod:
      oneOf:
        - $ref: '#/components/schemas/CxmlApplicationSmsMethod0'
        - $ref: '#/components/schemas/CxmlApplicationSmsMethod1'
      description: HTTP method for SMS URL
      title: CxmlApplicationSmsMethod
    CxmlApplicationSmsFallbackMethod0:
      type: string
      enum:
        - GET
      title: CxmlApplicationSmsFallbackMethod0
    CxmlApplicationSmsFallbackMethod1:
      type: string
      enum:
        - POST
      title: CxmlApplicationSmsFallbackMethod1
    CxmlApplicationSmsFallbackMethod:
      oneOf:
        - $ref: '#/components/schemas/CxmlApplicationSmsFallbackMethod0'
        - $ref: '#/components/schemas/CxmlApplicationSmsFallbackMethod1'
      description: HTTP method for SMS fallback URL
      title: CxmlApplicationSmsFallbackMethod
    CxmlApplicationSmsStatusCallbackMethod0:
      type: string
      enum:
        - GET
      title: CxmlApplicationSmsStatusCallbackMethod0
    CxmlApplicationSmsStatusCallbackMethod1:
      type: string
      enum:
        - POST
      title: CxmlApplicationSmsStatusCallbackMethod1
    CxmlApplicationSmsStatusCallbackMethod:
      oneOf:
        - $ref: '#/components/schemas/CxmlApplicationSmsStatusCallbackMethod0'
        - $ref: '#/components/schemas/CxmlApplicationSmsStatusCallbackMethod1'
      description: HTTP method for SMS status callbacks
      title: CxmlApplicationSmsStatusCallbackMethod
    CxmlApplication:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the cXML Application.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Project ID for the cXML Application
        friendly_name:
          type: string
          description: Display name of the cXML Application
        voice_url:
          type:
            - string
            - 'null'
          description: URL to handle incoming calls
        voice_method:
          $ref: '#/components/schemas/CxmlApplicationVoiceMethod'
          description: HTTP method for voice URL
        voice_fallback_url:
          type:
            - string
            - 'null'
          description: Fallback URL for voice errors
        voice_fallback_method:
          $ref: '#/components/schemas/CxmlApplicationVoiceFallbackMethod'
          description: HTTP method for voice fallback URL
        status_callback:
          type:
            - string
            - 'null'
          format: uri
          description: URL to receive status callbacks
        status_callback_method:
          $ref: '#/components/schemas/CxmlApplicationStatusCallbackMethod'
          description: HTTP method for status callbacks
        sms_url:
          type:
            - string
            - 'null'
          description: URL to handle incoming messages
        sms_method:
          $ref: '#/components/schemas/CxmlApplicationSmsMethod'
          description: HTTP method for SMS URL
        sms_fallback_url:
          type:
            - string
            - 'null'
          description: Fallback URL for SMS errors
        sms_fallback_method:
          $ref: '#/components/schemas/CxmlApplicationSmsFallbackMethod'
          description: HTTP method for SMS fallback URL
        sms_status_callback:
          type:
            - string
            - 'null'
          description: URL to receive SMS status callbacks
        sms_status_callback_method:
          $ref: '#/components/schemas/CxmlApplicationSmsStatusCallbackMethod'
          description: HTTP method for SMS status callbacks
      required:
        - id
        - project_id
        - friendly_name
        - voice_url
        - voice_method
        - voice_fallback_url
        - voice_fallback_method
        - status_callback
        - status_callback_method
        - sms_url
        - sms_method
        - sms_fallback_url
        - sms_fallback_method
        - sms_status_callback
        - sms_status_callback_method
      title: CxmlApplication
    CxmlApplicationResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the cXML Application.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the cXML Application Fabric Resource
        type:
          $ref: '#/components/schemas/CxmlApplicationResponseType'
          description: Type of the Fabric Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        cxml_application:
          $ref: '#/components/schemas/CxmlApplication'
          description: cXML Application data.
      required:
        - id
        - project_id
        - display_name
        - type
        - created_at
        - updated_at
        - cxml_application
      title: CxmlApplicationResponse
    CxmlApplicationPaginationResponse:
      type: object
      properties:
        self:
          type: string
          format: uri
          description: Linmk to the current page
        first:
          type: string
          format: uri
          description: Link to the first page
        next:
          type: string
          format: uri
          description: Link to the next page
        prev:
          type: string
          format: uri
          description: Link to the previous page
      required:
        - self
        - first
      title: CxmlApplicationPaginationResponse
    CxmlApplicationListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CxmlApplicationResponse'
          description: An array of objects containing the list of cXML Application(s) data.
        links:
          $ref: '#/components/schemas/CxmlApplicationPaginationResponse'
          description: Object containing pagination links
      required:
        - data
        - links
      title: CxmlApplicationListResponse
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    TypesStatusCodesStatusCode404Error:
      type: string
      enum:
        - Not Found
      title: TypesStatusCodesStatusCode404Error
    Types.StatusCodes.StatusCode404:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode404Error'
      required:
        - error
      description: The server cannot find the requested resource.
      title: Types.StatusCodes.StatusCode404
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: basic
      description: >-
        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)

        ```

```

## SDK Code Examples

```python
import requests

url = "https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications"

headers = {"Authorization": "Basic <project_id>:<api_token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications';
const options = {method: 'GET', headers: {Authorization: 'Basic <project_id>:<api_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <project_id>:<api_token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <project_id>:<api_token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications")
  .header("Authorization", "Basic <project_id>:<api_token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications', [
  'headers' => [
    'Authorization' => 'Basic <project_id>:<api_token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic <project_id>:<api_token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Basic <project_id>:<api_token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```