> 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. # Get call flow GET https://%7BYour_Space_Name%7D.signalwire.com/api/fabric/resources/call_flows/{id} Retrieves one Call Flow from your SignalWire project for viewing or editing. Use [List call flows](/docs/apis/rest/call-flows/list-call-flows) to find flows, or [Get SWML Script](/docs/apis/rest/swml-scripts/get-swml-script) for a directly authored SWML handler. #### 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/call-flows/get-call-flow ## 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) ``` ## Request ### Path parameters - `id` (string, required) — Unique ID of a Call Flow. ## Response ### 200 The request has succeeded. - `id` (string, required) — Unique ID of the Call Flow. - `project_id` (string, required) — Unique ID of the Project. - `display_name` (string, required) — Display name of the Call Flow Fabric Resource - `type` (enum, required) — Type of the Fabric Resource - Allowed values: `call_flow` - `created_at` (datetime, required) — Date and time when the resource was created. - `updated_at` (datetime, required) — Date and time when the resource was updated. - `call_flow` (CallFlow, required) — Call Flow data. ## 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 ### CallFlow - `id` (string, required) — Unique ID of a Call Flow. - `title` (string, required) — The name of the Call Flow - `flow_data` (CallFlowFlowData, optional) — Call Flow Builder state, stored as an opaque JSON object. Produced and consumed by the SignalWire Call Flow Builder UI; not used by SWML execution. - `relayml` (CallFlowRelayml, optional) — The calling SWML document this Call Flow executes. Uses [calling SWML methods](/docs/swml/reference/calling). - `document_version` (integer, optional) — The current revision of the call flow. Every update must increase this number. ### CallFlowFlowData Call Flow Builder state, stored as an opaque JSON object. Produced and consumed by the SignalWire Call Flow Builder UI; not used by SWML execution. ### CallFlowRelayml The calling SWML document this Call Flow executes. Uses [calling SWML methods](/docs/swml/reference/calling). ## Examples **Response** ```json { "id": "993ed018-9e79-4e50-b97b-984bd5534095", "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780", "display_name": "Welcome Call Flow", "type": "call_flow", "created_at": "2024-05-06T12:20:00Z", "updated_at": "2024-05-06T12:25:00Z", "call_flow": { "id": "993ed018-9e79-4e50-b97b-984bd5534095", "title": "Welcome Call Flow", "flow_data": {}, "relayml": { "sections": { "main": [ { "play": { "url": "https://cdn.signalwire.com/swml/audio.mp3" } } ] }, "version": "1.0.0" }, "document_version": 1 } } ``` **SDK Code** ```python Call flow import requests url = "https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows/id" response = requests.get(url, auth=("", "")) print(response.json()) ``` ```javascript Call flow const url = 'https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows/id'; 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 Call flow package main import ( "fmt" "net/http" "io" ) func main() { url := "https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows/id" 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 Call flow require 'uri' require 'net/http' url = URI("https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows/id") 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 Call flow 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/call_flows/id") .basicAuth("", "") .asString(); ``` ```php Call flow request('GET', 'https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows/id', [ 'headers' => [ ], 'auth' => ['', ''], ]); echo $response->getBody(); ``` ```csharp Call flow using RestSharp; using RestSharp.Authenticators; var client = new RestClient("https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows/id"); client.Authenticator = new HttpBasicAuthenticator("", ""); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` ```swift Call flow 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/call_flows/id")! 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() ```