Skip to main content
GET
/
fax_applications
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const faxApplications = await client.faxApplications.list();

console.log(faxApplications.data);
{
  "data": [
    {
      "id": "1293384261075731499",
      "record_type": "fax_application",
      "application_name": "fax-router",
      "active": false,
      "anchorsite_override": "Amsterdam, Netherlands",
      "webhook_event_url": "https://example.com",
      "webhook_event_failover_url": "https://failover.example.com",
      "webhook_timeout_secs": 25,
      "inbound": {
        "channel_limit": 10,
        "sip_subdomain": "example",
        "sip_subdomain_receive_settings": "only_my_connections"
      },
      "outbound": {
        "channel_limit": 10,
        "outbound_voice_profile_id": "1293384261075731499"
      },
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
object

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

filter
object

Consolidated filter parameter (deepObject style). Originally: filter[application_name][contains], filter[outbound_voice_profile_id]

sort
enum<string>
default:created_at

Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/> That is: <ul>

<li> <code>application_name</code>: sorts the result by the <code>application_name</code> field in ascending order. </li> <li> <code>-application_name</code>: sorts the result by the <code>application_name</code> field in descending order. </li> </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order.
Available options:
created_at,
application_name,
active
Example:

"application_name"

Response

Successful response

data
Fax Application · object[]
meta
object