Sent Faxes

List Sent Faxes

GET /sent_faxes — Returns a paginated list of sent faxes for your account.

Query params: page, page_size, from_number, to_number, patient_name, patient_dob, sender_name, recipient_name, date_start, date_end, is_test, sort, sort_dir.

bash
export API_BASE="https://api.medsender.com/api/v2"
export API_KEY="sk_test_..."

curl -s -H "Authorization: Bearer $API_KEY" \
  "$API_BASE/sent_faxes?page=1&page_size=10&date_start=2024-10-01&date_end=2024-10-31" | jq
export API_BASE="https://api.medsender.com/api/v2"
export API_KEY="sk_test_..."

curl -s -H "Authorization: Bearer $API_KEY" \
  "$API_BASE/sent_faxes?page=1&page_size=10&date_start=2024-10-01&date_end=2024-10-31" | jq

Response

JSON
{
  "sentFaxes": [
    {
      "fromNumber": "+15550100001",
      "toNumber": "+15550100002",
      "recipientName": "Dr. Example",
      "recordStatus": "activated",
      "patientName": "John Doe",
      "patientDob": "1990-01-15",
      "sendToken": "f5cfd99304f9",
      "senderName": "Example Provider",
      "expiry": "2025-02-15T14:30:00.000Z",
      "viewCount": 0,
      "note": "Referral documents",
      "sentAt": "2025-01-15T14:30:00.000Z",
      "completedAt": "2025-01-15T14:32:00.000Z",
      "sentStatus": "success",
      "documentType": "both",
      "errorDetails": null,
      "numPages": 3,
      "isTest": false
    }
  ],
  "meta": {
    "totalCount": 42,
    "totalPages": 5,
    "perPage": 10,
    "page": 1
  }
}
{
  "sentFaxes": [
    {
      "fromNumber": "+15550100001",
      "toNumber": "+15550100002",
      "recipientName": "Dr. Example",
      "recordStatus": "activated",
      "patientName": "John Doe",
      "patientDob": "1990-01-15",
      "sendToken": "f5cfd99304f9",
      "senderName": "Example Provider",
      "expiry": "2025-02-15T14:30:00.000Z",
      "viewCount": 0,
      "note": "Referral documents",
      "sentAt": "2025-01-15T14:30:00.000Z",
      "completedAt": "2025-01-15T14:32:00.000Z",
      "sentStatus": "success",
      "documentType": "both",
      "errorDetails": null,
      "numPages": 3,
      "isTest": false
    }
  ],
  "meta": {
    "totalCount": 42,
    "totalPages": 5,
    "perPage": 10,
    "page": 1
  }
}

Response Fields

FieldDescription
sendTokenUnique identifier for this fax (use this to retrieve status)
fromNumberThe Medsender fax number that sent this fax
toNumberThe destination fax number
sentStatusFax delivery status: "queued", "inprogress", "success", or "failure"
sentAtWhen the fax was queued for sending (ISO 8601)
completedAtWhen the fax finished sending (ISO 8601, null if still in progress)
numPagesNumber of pages in the fax
errorDetailsError information if sentStatus is "failure", otherwise null
isTestWhether this was sent using test credentials; null when a forwarded fax has no test flag
patientNamePatient name if provided when sending
patientDobPatient date of birth if provided
senderNameSender name if provided
recipientNameRecipient name if provided
noteInternal note if provided (for your reference only)
recordStatusRecord status: "activated", "archived", or "revoked"
documentTypeDocument type: "both", "document_only", or "access_code_sheet_only"
expiryWhen the secure link expires (30 days from creation)
viewCountNumber of times the fax has been viewed via secure link

Get Sent Fax

GET /sent_faxes/:id — Retrieves details for a specific sent fax.

The :id parameter is the fax's sendToken.

bash
curl -s -H "Authorization: Bearer sk_test_..." "https://api.medsender.com/api/v2/sent_faxes/REPLACE_SEND_TOKEN" | jq
curl -s -H "Authorization: Bearer sk_test_..." "https://api.medsender.com/api/v2/sent_faxes/REPLACE_SEND_TOKEN" | jq

Response

JSON
{
  "fromNumber": "+15550100001",
  "toNumber": "+15550100002",
  "recipientName": "Dr. Example",
  "recordStatus": "activated",
  "patientName": "John Doe",
  "patientDob": "1990-01-15",
  "sendToken": "f5cfd99304f9",
  "senderName": "Example Provider",
  "expiry": "2025-02-15T14:30:00.000Z",
  "viewCount": 2,
  "note": "Referral documents",
  "sentAt": "2025-01-15T14:30:00.000Z",
  "completedAt": "2025-01-15T14:32:00.000Z",
  "sentStatus": "success",
  "documentType": "both",
  "errorDetails": null,
  "numPages": 3,
  "isTest": false
}
{
  "fromNumber": "+15550100001",
  "toNumber": "+15550100002",
  "recipientName": "Dr. Example",
  "recordStatus": "activated",
  "patientName": "John Doe",
  "patientDob": "1990-01-15",
  "sendToken": "f5cfd99304f9",
  "senderName": "Example Provider",
  "expiry": "2025-02-15T14:30:00.000Z",
  "viewCount": 2,
  "note": "Referral documents",
  "sentAt": "2025-01-15T14:30:00.000Z",
  "completedAt": "2025-01-15T14:32:00.000Z",
  "sentStatus": "success",
  "documentType": "both",
  "errorDetails": null,
  "numPages": 3,
  "isTest": false
}

Send Fax

POST /sent_faxes — Sends a fax using multipart form data.

Request Parameters

ParameterRequiredDescription
fileYesPDF or TIFF file to send
from_numberYesYour Medsender fax number (E.164 format, e.g. +15550100001)
to_numberYesDestination fax number (E.164 format)
callback_urlNoURL to receive status callback when fax completes
patient_nameNoPatient name for record keeping
patient_dobNoPatient date of birth (YYYY-MM-DD)
sender_nameNoName of the person/org sending the fax
recipient_nameNoName of the intended recipient
noteNoInternal note for your reference (not sent in fax)
document_typeNoType of document: "both" (default), "document_only", or "access_code_sheet_only"
bash
export API_BASE="https://api.medsender.com/api/v2"
export API_KEY="sk_test_..."

curl -s -X POST -H "Authorization: Bearer $API_KEY" \
  -F "file=@./sample.pdf" \
  -F "from_number=+14155550100" \
  -F "to_number=+13125550123" \
  "$API_BASE/sent_faxes"
export API_BASE="https://api.medsender.com/api/v2"
export API_KEY="sk_test_..."

curl -s -X POST -H "Authorization: Bearer $API_KEY" \
  -F "file=@./sample.pdf" \
  -F "from_number=+14155550100" \
  -F "to_number=+13125550123" \
  "$API_BASE/sent_faxes"

Response

JSON
{
  "message": "Record has been sent, we will send a callback upon completion.",
  "faxId": "f5cfd99304f9"
}
{
  "message": "Record has been sent, we will send a callback upon completion.",
  "faxId": "f5cfd99304f9"
}