> 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. # Retrieve a Fax GET https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Faxes/{Sid} Retrieves one managed fax by SID so you can inspect its delivery progress, result, and document media. Use [List all Faxes](/docs/compatibility-api/rest/faxes/list-all-faxes) to discover SIDs; use [Get fax log](/docs/apis/rest/fax-logs/get-fax-log) when you only need a historical log entry. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Fax_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space). Reference: https://signalwire.com/docs/compatibility-api/rest/faxes/retrieve-fax ## 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 - `AccountSid` (string, required) — The Project ID that uniquely identifies the Account. - `Sid` (string, required) — The Fax ID that uniquely identifies the Fax. ## Response ### 200 The request has succeeded. - `account_sid` (string, required) — The unique identifier for the account this fax is associated with. - `api_version` (string, required) — The version of the SignalWire API. - `date_created` (string, required) — The date and time, in ISO 8601 format, the fax was created. - `date_updated` (string, required) — The date and time, in ISO 8601 format, the fax was updated. - `direction` (enum, required) — The direction of the fax. - Allowed values: `inbound`, `outbound` - `from` (string, required) — The phone number, in E.164 format, the fax was sent from. - `media_url` (string, required, nullable) — The URL hosting the received media, or null if not available. - `media_sid` (string, required) — The unique identifier for the media instance associated with the fax instance. - `num_pages` (string, required, nullable) — The number of pages in the fax document, or null if not yet determined. - `price` (string, required, nullable) — The cost of the fax, or null if not yet calculated. - `price_unit` (string, required) — The currency, in ISO 4217 format, of the price. - `quality` (enum, required) — The quality of the fax. - Allowed values: `standard`, `fine`, `superfine` - `sid` (string, required) — The unique identifier of the fax. - `status` (enum, required) — The status of the fax. - Allowed values: `queued`, `processing`, `sending`, `delivered`, `receiving`, `received`, `no-answer`, `busy`, `failed`, `canceled` - `to` (string, required) — The phone number, in E.164 format, the fax was sent to. - `duration` (integer, required) — The time, in seconds, it took to deliver a fax. - `links` (FaxLinks, required) — The URL links for resources associated with the fax. - `url` (string, required) — The URL of this resource. - `error_code` (string, required, nullable) — Error code for this resource, or null if no error. - `error_message` (string, required, nullable) — The description of this error, or null if no error. ## Errors ### 400 Bad Request Error The request was invalid or cannot be processed. Check the error details for more information. - `code` (integer, required) — Error code. - `message` (string, required) — Error message. - `more_info` (string, required) — URL for more information about the error. - `status` (integer, required) — HTTP status code. ### 401 Unauthorized Error Authentication failed. Please verify your credentials and try again. - `code` (integer, required) — Error code. - `message` (string, required) — Error message. - `more_info` (string, required) — URL for more information about the error. - `status` (integer, required) — HTTP status code. ### 404 Not Found Error The requested resource was not found. Please verify the resource identifier. - `code` (integer, required) — Error code. - `message` (string, required) — Error message. - `more_info` (string, required) — URL for more information about the error. - `status` (integer, required) — HTTP status code. ## Types ### FaxLinks Fax links. - `media` (string, required) — Media associated with this fax. ## Examples **Response** ```json { "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac", "api_version": "v1", "date_created": "2018-11-26T20:00:00Z", "date_updated": "2018-11-27T20:00:00Z", "direction": "inbound", "from": "+13103383454", "media_url": "https://example.com/fax.pdf", "media_sid": "b3877c40-da60-4998-90ad-b792e98472me", "num_pages": "3", "price": "-0.005", "price_unit": "USD", "quality": "standard", "sid": "b3877c40-da60-4998-90ad-b792e98472fx", "status": "queued", "to": "+13104456789", "duration": 5000, "links": { "media": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media" }, "url": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx", "error_code": null, "error_message": null } ``` **SDK Code** ```python import requests url = "https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes/Sid" response = requests.get(url, auth=("", "")) print(response.json()) ``` ```javascript const url = 'https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes/Sid'; 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.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes/Sid" 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.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes/Sid") 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.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes/Sid") .basicAuth("", "") .asString(); ``` ```php request('GET', 'https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes/Sid', [ 'headers' => [ ], 'auth' => ['', ''], ]); echo $response->getBody(); ``` ```csharp using RestSharp; using RestSharp.Authenticators; var client = new RestClient("https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes/Sid"); 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.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes/Sid")! 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() ```