> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.
# List cXML Scripts
GET https://%7BYour_Space_Name%7D.signalwire.com/api/fabric/resources/cxml_scripts
Lists the project's addressable cXML Scripts, which store calling or messaging instructions in SignalWire. These are the same scripts the Compatibility API exposes as [LamlBins](/docs/compatibility-api/rest/cxml-scripts/list-cxml-scripts), addressed there by SID. Use [cXML Webhooks](/docs/apis/rest/cxml-webhook/list-cxml-webhooks) when your server must return cXML for each request, or [SWML Scripts](/docs/apis/rest/swml-scripts/list-swml-scripts) for SWML 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/rest/cxml-scripts/list-cxml-scripts
## Authentication
- `Authorization` header (basic auth, required) — 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
### 200
The request has succeeded.
- `data` (list of CXMLScriptResponse, required) — An array of objects containing a list of cXML Script data
- `links` (CXMLScriptAddressPaginationResponse, required) — Object containing pagination links
## Errors
### 401 Unauthorized Error
Access is unauthorized.
- `error` (enum, required)
- Allowed values: `Unauthorized`
### 404 Not Found Error
The server cannot find the requested resource.
- `error` (enum, required)
- Allowed values: `Not Found`
### 500 Internal Server Error
An internal server error occurred.
- `error` (enum, required)
- Allowed values: `Internal Server Error`
## Types
### CXMLScriptResponse
- `id` (string, required) — Unique ID of the cXML Script.
- `project_id` (string, required) — Unique ID of the Project.
- `name` (string, required) — Display name of the cXML Script Fabric Resource
- `type` (enum, required) — Type of the Fabric Resource
- Allowed values: `cxml_script`
- `created_at` (datetime, required) — Date and time when the resource was created.
- `updated_at` (datetime, required) — Date and time when the resource was updated.
- `cxml_script` (CXMLScript, required) — cXML Script data.
### CXMLScriptAddressPaginationResponse
- `self` (string, required) — Link of the current page
- `first` (string, required) — Link to the first page
- `next` (string, optional) — Link to the next page
- `prev` (string, optional) — Link to the previous page
### CXMLScript
- `id` (string, required) — Unique ID of a cXML Script.
- `contents` (string, required) — The cXML script contents
- `request_count` (integer, required) — The amout of times the cXML script has been requested
- `last_accessed_at` (datetime, required, nullable) — The date and time when the cXML script was last accessed
- `request_url` (string, required) — The URL where the cXML script can be accessed
- `script_type` (enum, required) — The script type the cXML Script is used for
- Allowed values: `calling`, `messaging`
- `display_name` (string, required) — Display name of the cXML Script Fabric Resource
- `status_callback_url` (string, optional, nullable) — The url that will send status updates for the cXML Script
- `status_callback_method` (enum, optional) — HTTP method for status callback URL
- Allowed values: `GET`, `POST`
## Examples
**Response**
```json
{
"data": [
{
"id": "993ed018-9e79-4e50-b97b-984bd5534095",
"project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
"name": "Reception Script",
"type": "cxml_script",
"created_at": "2024-05-06T12:20:00Z",
"updated_at": "2024-05-06T12:20:00Z",
"cxml_script": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"contents": "Hello World",
"request_count": 5,
"last_accessed_at": "2023-10-01T12:00:00Z",
"request_url": "https://example.signalwire.com/laml-bins/2537c89e-2606-48c2-b3c2-bb601d863d1e",
"script_type": "calling",
"display_name": "Booking Assistant Script",
"status_callback_url": "https://example.com/cxml/status",
"status_callback_method": "POST"
}
}
],
"links": {
"self": "https://example.signalwire.com/api/fabric/resources/cxml_scripts?page_number=0&page_size=50&type=cxml_script",
"first": "https://example.signalwire.com/api/fabric/resources/cxml_scripts?page_size=50&type=cxml_script",
"next": "https://example.signalwire.com/api/fabric/resources/cxml_scripts?page_number=1&page_size=50&page_token=PA08cdad0c-e7e6-4a75-8244-902524f38d55&type=cxml_script",
"prev": "https://example.signalwire.com/api/fabric/resources/cxml_scripts?page_number=0&page_size=50&page_token=PA08cdad0c-e7e6-4a75-8244-902524f38d55&type=cxml_script"
}
}
```
**SDK Code**
```python
import requests
url = "https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_scripts"
response = requests.get(url, auth=("", ""))
print(response.json())
```
```javascript
const url = 'https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_scripts';
const credentials = btoa(":");
const options = {method: 'GET', headers: {Authorization: `Basic ${credentials}`}};
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_scripts"
req, _ := http.NewRequest("GET", url, nil)
req.SetBasicAuth("", "")
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_scripts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request.basic_auth("", "")
response = http.request(request)
puts response.read_body
```
```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;
HttpResponse response = Unirest.get("https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_scripts")
.basicAuth("", "")
.asString();
```
```php
request('GET', 'https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_scripts', [
'headers' => [
],
'auth' => ['', ''],
]);
echo $response->getBody();
```
```csharp
using RestSharp;
using RestSharp.Authenticators;
var client = new RestClient("https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_scripts");
client.Authenticator = new HttpBasicAuthenticator("", "");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```
```swift
import Foundation
let credentials = Data(":".utf8).base64EncodedString()
let headers = ["Authorization": "Basic \(credentials)"]
let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_scripts")! 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()
```