List all Fax Applications

This endpoint returns a list of your Fax Applications inside the ‘data’ attribute of the response. You can adjust which applications are listed by using filters. Fax Applications are used to configure how you send and receive faxes using the Programmable Fax API with Telnyx.

GET /fax_applications

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const faxApplication of client.faxApplications.list()) {
  console.log(faxApplication.id);
}

200

{
  "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": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

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]

Show child attributes

filter · object

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

Show child attributes

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 - prefix.

That is:

• application_name: sorts the result by the application_name field in ascending order.
• -application_name: sorts the result by the application_name field in descending order.

If not given, results are sorted by created_at in descending order.

Available options: created_at, application_name, active

Example:

"application_name"

Response

200

application/json

Successful response

data · Fax Application · object[]

Show child attributes

meta · object

Show child attributes