Fax History API Reference

This defines the Fax History API:

  • Request - Get fax history.
  • Response - ensure that your request to the Fax API was successful.

Request

A Fax API request looks like:

https://fax.to/api/v2/fax?api_key=xxxxx&limit=xx&page=xx

This request contains:

Parameters

The following table shows the parameters you use in the request:

Parameter Description Required
limit The number of record to return. For example, limit=10. No.
page The page you want to get. Basically its pagination. For example, page=1. No.

Authentication information

The following table shows the information for authentication:

Parameter Description Required
api_key Your Key. For example, api_key=f@x2r0ckkz. Yes.

You find your Key in Dashboard.

Security

To ensure privacy, you must use HTTPS for all Faxto API requests.

Encoding

You submit all requests with a POST or GET call using UTF-8 encoding and URL encoded values.

Response

We support JSON ONLY responses


{
  "status": "success",
  "history": [
    {
      "id": 92334,
      "created": {
        "date": "2017-03-09 15:35:28.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "document_id": 112601,
      "document": "FAX11920.pdf",
      "recipient": "441224459292",
      "status": "success"
    },
    {
      "id": 92322,
      "created": {
        "date": "2017-03-09 15:05:36.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "document_id": 112601,
      "document": "FAX11920.pdf",
      "recipient": "441224459292",
      "status": "success"
    }, ...

Keys and Values

Key Value Response Type
status The status of the API request JSON
history Array containing the fax jobs requested JSON

Response Messages

HTTP Status Code Reason
200 Successful response
401 Unauthorized.
403 Rate limit exceeded
404 Resource not Found
500 Internal server error