curl --request GET \
--url https://api.mintfax.com/v1/faxes/{fax} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.mintfax.com/v1/faxes/{fax}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.mintfax.com/v1/faxes/{fax}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mintfax.com/v1/faxes/{fax}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.mintfax.com/v1/faxes/{fax}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.mintfax.com/v1/faxes/{fax}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mintfax.com/v1/faxes/{fax}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "fax_8aZqRm4yT3vK7pNxJ2bH9c",
"status": "queued",
"to": "+12125551234",
"pages": 123,
"error_code": "<string>",
"error_subcode": "<string>",
"error_message": "<string>",
"max_attempts": "3",
"attempts": [
{
"attempt_number": 123,
"started_at": "<string>",
"completed_at": "<string>",
"duration_ms": 123,
"error_code": "<string>",
"error_subcode": "<string>",
"error_message": "<string>"
}
],
"webhook_url": "<string>",
"idempotency_key": "<string>",
"tags": {},
"csid": "<string>",
"page_size": "letter",
"resolution": "standard",
"optimize_for": "text",
"submitted_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Get a Fax
Returns the full fax record including status, error details, and timing.
curl --request GET \
--url https://api.mintfax.com/v1/faxes/{fax} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.mintfax.com/v1/faxes/{fax}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.mintfax.com/v1/faxes/{fax}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mintfax.com/v1/faxes/{fax}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.mintfax.com/v1/faxes/{fax}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.mintfax.com/v1/faxes/{fax}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mintfax.com/v1/faxes/{fax}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "fax_8aZqRm4yT3vK7pNxJ2bH9c",
"status": "queued",
"to": "+12125551234",
"pages": 123,
"error_code": "<string>",
"error_subcode": "<string>",
"error_message": "<string>",
"max_attempts": "3",
"attempts": [
{
"attempt_number": 123,
"started_at": "<string>",
"completed_at": "<string>",
"duration_ms": 123,
"error_code": "<string>",
"error_subcode": "<string>",
"error_message": "<string>"
}
],
"webhook_url": "<string>",
"idempotency_key": "<string>",
"tags": {},
"csid": "<string>",
"page_size": "letter",
"resolution": "standard",
"optimize_for": "text",
"submitted_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Authorizations
API key as Bearer token. Use an account key (mfx_acct_...) for
/account/* endpoints, and an environment key (mfx_test_... for
sandbox, mfx_live_... for live) for /environment/*, /faxes,
/webhooks, and /events.
Path Parameters
The fax public id
Response
FaxResource
Unique fax identifier (fax_-prefixed).
"fax_8aZqRm4yT3vK7pNxJ2bH9c"
Current fax status.
queued, submitted, in_progress, delivered, failed "queued"
Destination fax number in E.164 format.
"+12125551234"
Number of pages, null until processing begins.
Machine-readable failure code, if any.
Optional finer-grained mintfax-owned subcode, if any.
Human-readable failure description, if any.
Configured retry cap for this fax (1-5). See ADR-021.
"3"
Per-attempt delivery detail in chronological order. See ADR-021.
Show child attributes
Show child attributes
Per-fax webhook override URL.
Caller-supplied idempotency key.
Caller-supplied metadata map. Empty serializes as {}.
Show child attributes
Show child attributes
Sender CSID transmitted in the T.30 fax handshake (max 20 chars).
Target page size for content mintfax renders. PDF inputs pass through unchanged.
letter, legal, a4, b4 T.30 transmission resolution.
standard, fine Rasterizer optimization hint for non-PDF inputs.
text, photo UTC timestamp when the fax was submitted to a carrier. Null until submission.
UTC timestamp when the fax reached a terminal status. Null until completion.
UTC timestamp when the fax record was created.
UTC timestamp when the fax record was last updated.