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
Authorizations
Authorization
string
headerrequiredOAuth2 Authorization Grant
Path Parameters
user_id
string
default: selfrequiredself or user id of a corporate member
Query Parameters
category
enum<string>
default: inboxCategory parameter. Valid values: inbox, sent, spam
Available options:
inbox
, sent
, spam
after
string
Start date to get records from that date. Format: YYYY-MM-DD HH:mm:ss
before
string
End date to get records before that date. Format: YYYY-MM-DD HH:mm:ss
limit
integer
default: 50Limit of fax records you want to get per request
Required range:
1 < x < 50
offset
integer
default: 0Offset for pagination. Specifies the number of records to skip before starting to return records.
Required range:
x > 0
sort_by
enum<string>
Field to sort the results by. Valid values: date, from, to, comment, pages
Available options:
date
, from
, to
, comment
, pages
order
enum<string>
default: ascOrder of the sorting. Valid values: asc for ascending, desc for descending.
Available options:
asc
, desc
Response
200 - application/json
List of fax data
data
object