Skip to main content
GET
List Faxes

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

direction
enum<string> | null

Direction of a fax. INBOUND is defined now so inbound work later just adds rows.

Available options:
OUTBOUND,
INBOUND
status
enum<string> | null

Lifecycle status of a fax. Values mirror SignalWire's LaML fax status values.

Available options:
QUEUED,
SENDING,
DELIVERED,
FAILED,
CANCELED,
NO_ANSWER,
BUSY
faxContactId
string | null
phoneNumberId
string | null
beforeDate
string<date-time> | null
afterDate
string<date-time> | null
cursor
string | null
perPage
integer
default:50
Required range: 1 <= x <= 200

Response

Successful Response

data
FaxListItem · object[]
required
total
integer
required
nextCursor
string | null