
Phaxio
Fax API integration for automated fax workflows
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.phaxio.com/v2.1 | link | — | — | — |
Actions (63)
ATAs · 22
- Add a phone number to ATAPOST atas/{ata_id}/add_phone_number
Associate a phone number with an ATA.
documented - Add a phone number to ATAPOST atas/{ata_id}/add_phone_number
Add phone number to ATA.
documented - Create ATA GroupPOST atas/groups
Create a new ATA Group.
documented - Create ATA GroupPOST atas/groups
Create an ATA Group.
documented - Create an ATAPOST atas
Create a new ATA device/account entry.
documented - Create an ATAPOST atas
Create ATA.
documented - Delete ATA GroupDELETE atas/groups/{group_id}
Delete ATA Group.
documented - Delete ATA GroupDELETE atas/groups/{group_id}
Delete an ATA Group.
documented - Delete an ATADELETE atas/{ata_id}
Delete an ATA.
documented - Delete an ATADELETE atas/{ata_id}
Delete an ATA from the account.
documented - Get ATAGET atas/{ata_id}
Retrieve details of a specific ATA.
documented - Get ATAGET atas/{ata_id}
Get ATA info.
documented - List ATA GroupsGET atas
List ATA Groups.
documented - List ATA GroupsGET atas
List ATA groups.
documented - List ATAsGET atas
List ATAs.
documented - List ATAsGET atas
List registered ATAs in your account.
documented - Regenerate ATA credentialsPOST atas/{ata_id}/regenerate_credentials
Regenerate credentials for an ATA.
documented - Regenerate ATA credentialsPOST atas/{ata_id}/regenerate_credentials
Regenerate ATA credentials.
documented - Remove a phone number from ATAPOST atas/{ata_id}/remove_phone_number
Remove a phone number from an ATA.
documented - Remove a phone number from ATAPOST atas/{ata_id}/remove_phone_number
Remove phone number from ATA.
documented - Update an ATAPUT atas/{ata_id}
Update an ATA's configuration.
documented - Update an ATAPUT atas/{ata_id}
Update ATA.
documented
Faxes · 20
- Cancel faxPOST faxes/{fax_id}/cancel
Cancel a fax that is queued or in progress.
documented - Cancel faxPOST faxes/{fax_id}/cancel
Cancel a fax in progress.
documented - Delete faxDELETE faxes/{fax_id}
Delete a fax.
documented - Delete faxDELETE faxes/{fax_id}
Delete a fax record (full delete only for test faxes; live faxes may only delete stored files).
documented - Delete fax fileDELETE faxes/{fax_id}/file
Delete fax file.
documented - Delete fax fileDELETE faxes/{fax_id}/file
Delete the stored file for a fax.
documented - Get faxGET faxes/{fax_id}
Retrieve info for a fax.
documented - Get fax contentGET faxes/{fax_id}/file
Retrieve fax file or thumbnail.
documented - Get fax content file or thumbnailGET faxes/{fax_id}/file
Download the fax content file (PDF) or a thumbnail image (thumbnail parameter supported).
documented - Get fax infoGET faxes/{fax_id}
Retrieve the metadata and status for a specific fax.
documented - List faxes in date rangeGET faxes
List faxes within a date/time window (supports paging and filters).
documented - List faxes in date rangeGET faxes
List faxes in a date range.
documented - List supported countries for sendingGET public/list_countries
List supported countries for sending faxes.
documented - List supported countries for sendingGET public/list_countries
List countries supported for sending faxes (and pricing in some docs).
documented - Receive fax callbackPOST faxes/receive_callback
Endpoint to receive inbound fax callbacks from Phaxio when a fax is received.
documented - Resend faxPOST faxes/{fax_id}/resend
Resend a fax.
documented - Resend faxPOST faxes/{fax_id}/resend
Resend a fax that previously failed or was canceled.
documented - Send faxPOST faxes
Create and queue a fax for sending (legacy v2).
documented - Send faxPOST faxes
Create and queue a fax for sending to one or more recipients using files and/or content URLs. (source: Phaxio v2.1 Create and send a fax)
documented - Test receive faxPOST faxes?direction=received
Simulate receiving a fax for testing purposes (direction=received).
documented
Phone numbers · 10
- Get number infoGET phone_numbers/{number}
Retrieve information about a provisioned phone number.
documented - Get number infoGET phone_numbers/{number}
Get number info.
documented - List area codes available for purchasing numbersGET public/area_codes
List area codes available for purchase (duplicate entry but shown for completeness).
documented - List area codes available for purchasing numbersGET public/area_codes
Retrieve area codes available for Phaxio number provisioning.
documented - List numbersGET phone_numbers
List numbers.
documented - List numbersGET phone_numbers
List Phaxio numbers owned by your account.
documented - Provision a numberPOST phone_numbers
Provision a new phone number.
documented - Provision a numberPOST phone_numbers
Provision a new Phaxio phone number for receiving faxes.
documented - Release a numberDELETE phone_numbers/{number}
Release a previously provisioned phone number.
documented - Release a numberDELETE phone_numbers/{number}
Release a number.
documented
Addresses · 5
- Create an addressPOST addresses
Create a new address record for verification/provisioning.
documented - Create an addressPOST addresses
Create an address.
documented - Get addressGET addresses/{address_id}
Retrieve a stored address record.
documented - List addressesGET addresses
List all addresses on the account.
documented - Submit address for verificationPOST addresses/submit
Submit an address for verification with required documentation.
documented
Porting · 5
- Create port orderPOST port_orders
Create a new porting order.
documented - Get port number infoGET port_numbers/{port_number_id}
Get details for a port number in progress.
documented - Get port order infoGET port_orders/{port_order_id}
Get details for a port order.
documented - List port number notesGET port_number_notes
List notes related to port numbers.
documented - List port ordersGET port_orders
List porting orders.
documented