Sign in

v1

latestOpenAPI 3.0.12026-07-266184114.0 KB
Faxes

List fax records

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

get/accounts/{user_id}/faxes

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'

Category parameter. Valid string values: inbox (received faxes), sent (outgoing faxes), or spam (spam faxes). Optional, defaults to 'inbox'.

afterstring

Start date to get records from that date. Format: YYYY-MM-DD HH:mm:ss (e.g., '2018-01-01 00:00:00'). Optional, if omitted returns all records from the beginning.

beforestring

End date to get records before that date. Format: YYYY-MM-DD HH:mm:ss (e.g., '2020-01-01 00:00:00'). Optional, if omitted returns all records up to the current time.

limitinteger

Maximum number of fax records to return per request. Must be between 1 and 50. Optional, defaults to 50. Use with 'offset' for pagination.

offsetinteger

Offset for pagination. Specifies the number of records to skip before starting to return records. Optional, defaults to 0.

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 list of valid fax statuses

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"
      }
    ]
  }
}