FAfax
Faxes

List fax records

Changed on

Get your own or your subordinate's faxes list. (Permitted scopes: fax:all:read, fax:fax:read)

get/accounts/{user_id}/faxes

Request

  • Base URL
    https://restapi.fax.plus/v3
  • URL
    https://restapi.fax.plus/v3/accounts/{user_id}/faxes
  • Auth
    • OAuth 2
      Authorization code: https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all
      Token URL: https://accounts.fax.plus/token scopes: all
    • or HTTP bearer

Path parameters

user_idstring required

User ID. Use 'self' for your own account, or provide a specific user ID for corporate member accounts.

Query parameters

category'inbox' | 'sent' | 'spam'

Optional. inbox (default), sent, or spam. See Listing tips below for what each includes.

afterstring

Optional UTC lower bound (YYYY-MM-DD HH:MM:SS). Exclusive: records on this exact second are not included.

beforestring

Optional UTC upper bound (YYYY-MM-DD HH:MM:SS). Exclusive: records on this exact second are not included.

limitinteger

Optional. Maximum records per request, 1–50 (default 50). The response does not include a has_more field.

offsetinteger

Optional. Number of matching records to skip (default 0). Use with limit for pagination.

sort_by'date' | 'from' | 'to' | 'comment' | 'pages'

Field to sort the results by. Valid values: date, from, to, comment, pages. Optional.

order'asc' | 'desc'

Order of the sorting. Valid values: asc for ascending, desc for descending. Optional, defaults to 'asc'.

in_progressboolean

Return in-progress incoming faxes. Optional, defaults to false. This functionality can be enabled on request.

statusFaxStatus[]

Filter by transmission status. Comma-separated.

from_numberstring

Filter by source/from fax number in E.164 format

to_numberstring

Filter by destination/to fax number in E.164 format

is_readboolean

Filter by read status. true for read faxes, false for unread faxes

min_pagesinteger

Filter faxes with at least this many pages

max_pagesinteger

Filter faxes with at most this many pages

Response

Response containing a list of faxes

Example response

{
  "data": {
    "records": [
      {
        "comment": "",
        "cost": 2,
        "cost_details": {
          "multiplier": 1,
          "notification_cost": 0
        },
        "description": "OK",
        "direction": "incoming",
        "duration": 0,
        "file": "ec28edc283a74daca1787efb5fa6fae2.tiff",
        "file_name": "fax-from-12076001783",
        "from_number": "+12076001783",
        "header": null,
        "id": "5e7de3ad54cfd54eb568cc76",
        "is_read": false,
        "is_spam": false,
        "last_update": "2020-03-27 11:29:49",
        "max_retry": null,
        "owner_id": "74d59d2779fb42a99cd5bb993c0c89d2",
        "pages": 2,
        "retry_delay": null,
        "scheduled_time": null,
        "start_time": "2020-03-27 11:29:21",
        "status": "failed",
        "submit_time": null,
        "to": "+12076001783"
      }
    ]
  }
}

Changes

  • 95a35a892239Revision changes
    • breaking

      the /// response property's max was increased from 180.00 to 720.00 for the response status

    • warning

      added the new failed_call_rejected enum value to the /// response property for the response status

    • warning

      added the new failed_destination_out_of_order enum value to the /// response property for the response status

    • warning

      added the new failed_exchange_routing_error enum value to the /// response property for the response status

    • warning

      added the new failed_network_out_of_order enum value to the /// response property for the response status

    • warning

      added the new failed_no_origination enum value to the /// response property for the response status

    • warning

      added the new failed_no_route_destination enum value to the /// response property for the response status

    • warning

      added the new failed_no_user_response enum value to the /// response property for the response status

    • warning

      added the new failed_normal_circuit_congestion enum value to the /// response property for the response status

    • warning

      added the new failed_origination_unknown enum value to the /// response property for the response status

    • warning

      added the new failed_recovery_on_timer_expire enum value to the /// response property for the response status

    • warning

      added the new failed_requested_chan_unavail enum value to the /// response property for the response status

    • info

      added the enum value failed_call_rejected to the property items/ of the query request parameter status

    • info

      added the enum value failed_destination_out_of_order to the property items/ of the query request parameter status

    • info

      added the enum value failed_exchange_routing_error to the property items/ of the query request parameter status

    • info

      added the enum value failed_network_out_of_order to the property items/ of the query request parameter status

    • info

      added the enum value failed_no_origination to the property items/ of the query request parameter status

    • info

      added the enum value failed_no_route_destination to the property items/ of the query request parameter status

    • info

      added the enum value failed_no_user_response to the property items/ of the query request parameter status

    • info

      added the enum value failed_normal_circuit_congestion to the property items/ of the query request parameter status

    • info

      added the enum value failed_origination_unknown to the property items/ of the query request parameter status

    • info

      added the enum value failed_recovery_on_timer_expire to the property items/ of the query request parameter status

    • info

      added the enum value failed_requested_chan_unavail to the property items/ of the query request parameter status

    • info

      added the optional property /// to the response with the status