List all Fax Applications

gethttps://api.telnyx.com/v2/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.

curl -X GET \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "Authorization: Bearer YOUR_API_KEY" \ --globoff "https://api.telnyx.com/v2/fax_applications?page[number]=1&page[size]=20"

Parameters

In Query
page[number]
integer
(1)
optional
The page number to load
Default:
1
page[size]
integer
(1 - 250)
optional
The size of the page
Default:
20
filter[application_name][contains]
string
optional
If present, applications with application_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
Default:
"null"
filter[outbound_voice_profile_id]
string
(int64)
optional
Identifies the associated outbound voice profile.
Example: "1293384261075731499"
sort
string
optional
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:
  • connection_name: sorts the result by the connection_name field in ascending order.
  • -connection_name: sorts the result by the connection_name field in descending order.

If not given, results are sorted by created_at in descending order.
Default:
"created_at"
Example: "connection_name"Options: [ "created_at", "connection_name", "active" ]

Responses

200
Successful response
400
Bad request
401
Unauthorized
404
Resource not found

Success Response

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

...

posthttps://api.telnyx.com/v2/fax_applications

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/fax_applications/{id}

...

...

Parameters

Responses

Success Response

...

patchhttps://api.telnyx.com/v2/fax_applications/{id}

...

...

Parameters

Responses

Success Response

...

deletehttps://api.telnyx.com/v2/fax_applications/{id}

...

...

Parameters

Responses

Success Response

Was this page helpful?