List received faxes

List received faxes

Use an enabled MultiTEL API account over HTTPS with its configured credentials and IP restrictions. This endpoint lists received faxes belonging to the authenticated account. It does not send a fax or download its document.

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode page=1 \
  --data-urlencode limit=25 \
  --data-urlencode date_from=2026-10-01 \
  --data-urlencode date_to=2026-10-02 \
  https://api.multitel.net/v3/fax_inbox

Date bounds are inclusive and use the API server's date interpretation, not a requested user time zone. Invalid date strings may be ignored rather than rejected; validate them before sending. With no date filters, the handler imposes no default date window. Results are ordered by received time, newest first. The endpoint does not provide a stable snapshot across pages: new arrivals can move records between pages.

Read the mailbox page

Read the HTTP result and the JSON status.code. Failures elsewhere in the API can use a JSON error envelope even when HTTP status is 200. A successful response contains response.faxes and response.pagination. This example uses fictional values.

{
  "status": {"code": 200, "msg": ""},
  "response": {
    "faxes": [{
      "id": 12,
      "hash": "c20ad4d76fe97759aa27a0c99bff6710",
      "from_number": "+12125550123",
      "to_number": "+12125550124",
      "remote_station_id": "Example sender",
      "pages": 2,
      "cost": 0.05,
      "received_at": "2026-10-01 12:00:00",
      "received_timestamp": 1790856000,
      "status": "success",
      "status_text": "OK",
      "emailed": "yes",
      "viewed": false
    }],
    "pagination": {"page": 1, "limit": 25, "total": 1, "total_pages": 1}
  }
}

id is the numeric inbox record ID. hash is its MD5 representation for the legacy inbound document workflow; it is not a send_fax job ID or an authorization credential. Do not use it with the outbound fax_status endpoint.

received_timestamp is the stored Unix timestamp. received_at is a server-formatted timestamp without a time-zone offset, or null if no received time is recorded; use the Unix value when displaying times in your own time zone. cost is a JSON number, not a price quote or proof of a separate completed charge.

status is success only for a stored status code of zero; other values become failed. status_text carries the stored processing message, with OK or Failed as a fallback. emailed preserves the stored value rather than a Boolean. viewed is a Boolean. Do not infer successful email delivery solely from the fax status.

Handle empty and changing lists

An empty mailbox returns an empty faxes array, total 0 and total_pages 0. A page beyond the final page can also return an empty array. Stop according to the pagination fields rather than assuming at least one page. No cursor or secondary record-ID sort is exposed. Retain record IDs when reconciling overlapping pages.

Document access and privacy

Mailbox entries contain private telephone and document metadata. Restrict access in your application and avoid logging complete responses. Listing does not mark a document as viewed. Use fax_file for the compatibility inbound download, noting that it marks an existing inbound record as viewed even if its file is unavailable. The portal inbox is also available for document access. No file-retention guarantee has been established.