{
"opencollection": "1.0.0",
"info": {
"name": "Telnyx Access Tokens Programmable Fax Applications API",
"version": "2.0.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Programmable Fax Applications",
"type": "folder"
},
"items": [
{
"info": {
"name": "List all Fax Applications",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.telnyx.com/v2/fax_applications",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Consolidated filter parameter (deepObject style). Originally: filter[application_name][contains], filter[outbound_voice_profile_id]"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.
\nThat is:
application_name: sorts the result by the\n application_name field in ascending order.\n -application_name: sorts the result by the\n application_name field in descending order.\n created_at in descending order."
}
]
},
"docs": "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."
},
{
"info": {
"name": "Creates a Fax Application",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.telnyx.com/v2/fax_applications",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new Fax Application based on the parameters sent in the request. The application name and webhook URL are required. Once created, you can assign phone numbers to your application using the `/phone_numbers` endpoint."
},
{
"info": {
"name": "Retrieve a Fax Application",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.telnyx.com/v2/fax_applications/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifies the resource."
}
]
},
"docs": "Return the details of an existing Fax Application inside the 'data' attribute of the response."
},
{
"info": {
"name": "Update a Fax Application",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.telnyx.com/v2/fax_applications/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifies the resource."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates settings of an existing Fax Application based on the parameters of the request."
},
{
"info": {
"name": "Deletes a Fax Application",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.telnyx.com/v2/fax_applications/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifies the resource."
}
]
},
"docs": "Permanently deletes a Fax Application. Deletion may be prevented if the application is in use by phone numbers."
}
]
}
],
"bundled": true
}