Faxes

Get fax status

Get the current status and details for a sent or received fax using its fax_id. The response includes direction, status, folder, sender and recipient information, page count, transmission details, and timestamps. Status is received, sending, delivered, or failed; direction is inbound or outbound; and folder is INBOX, OUTBOX, or TRASH. Download the fax document separately with GET /v1/faxes/{faxId}/content.

get/v1/faxes/{faxId}

Request

  • Base URL: https://api.efax.com
  • URL: https://api.efax.com/v1/faxes/{faxId}
  • Auth: HTTP bearer

Path parameters

faxIdstring uuid required

Fax identifier returned when a fax is sent or listed.

Response

The requested fax and its current status.

fax_idstring nullable
directionstring nullable
statusstring nullable
folderstring nullable
originating_fax_numberstring nullable
senderstring nullable
subjectstring nullable
page_countinteger nullable
has_cover_pageboolean
created_atstring date-time nullable
received_atstring date-time nullable
completed_atstring date-time nullable
readboolean
favoriteboolean

Changes

No recorded changes to this operation across all 1 revision of this API.