Knowledge Base

Release Notes

Compliance & Security

Blog

Fax.Plus API

Create an account

Python

Integrate online fax functionalities in your workflow

Introduction

Quickstart

Authentication

Outbox

Number

Webhook

Javascript

Get account information of all members of your corporate account. (Allowed scopes: **fax:all:read**, **fax:member:read**)

List corporate members

Get information about an account. For members user_id can only be self. For admin it can be either self, or a user_id of any corporate member. (Allowed scopes: **fax:all:read**, **fax:member:read**, **fax:user:read**)

Get account information

Modify personal information of your own account or your corporate member's account. user_id can be either self, or a subordinate's user_id. (Allowed scopes: **fax:all:edit**, **fax:member:edit**, **fax:user:edit**)

Modify account information

Get corporate member's role and faxing quota (Allowed scopes: **fax:all:read**, **fax:member:read**)

Get member details

Update corporate member's role and faxing quota. (Allowed scopes: **fax:all:edit**, **fax:member:edit**)

Modify member details

List your purchased/assigned phone numbers. For corporate members all assigned numbers will be returned, while for the corporate admin, all purchased numbers. (Allowed scopes: **fax:all:read**, **fax:numbers:read**)

List phone numbers

Get information about a single purchased/assigned fax number (Allowed scopes: **fax:all:read**, **fax:numbers:read**)

Get number information

Assign fax number to a corporate member (Allowed scopes: **fax:all:edit**, **fax:numbers:edit**)

Assign number

Revoke fax number from a corporate member. To revoke your own number use self as a user_id. (Allowed scopes: **fax:all:edit**, **fax:numbers:edit**)

Revoke number

Get your own or your subordinate's faxes list. (Allowed scopes: **fax:all:read**, **fax:fax:read**)

List fax records

Get a specific fax record details like duration, pages etc. (Allowed scopes: **fax:all:read**, **fax:fax:read**)

Get a fax record

You can modify a fax record's comment or mark it as read. (Allowed scopes: **fax:all:edit**, **fax:fax:edit**)

Modify fax record

Delete a specific fax record by providing its id. (Allowed scopes: **fax:all:edit**, **fax:fax:edit**)

Delete a fax

Before sending a fax you need to upload your files using this API. In order to upload your fax file, you have to send a `multipart/form-data` request with your file. Set the `name` to `fax_file`, `filename` to your file's name with extension, and the Content-Type to the file's MIME type. In most cases, the `filename` directive will be automatically added by your library of choice. If the upload was successful you would receive a `file_path` which you can use to send your fax. (Allowed scopes: **fax:all:edit**, **fax:file:edit**)

Upload a file

Download sent or received fax file. (Allowed scopes: **fax:all:read**, **fax:file:read**)

Download fax file

Retrieve fax confirmation report (Allowed scopes: **fax:all:read**, **fax:fax:read**)

Get fax confirmation report

Retrieve fax thumbnail (Allowed scopes: **fax:all:read**, **fax:fax:read**)

Get fax thumbnail

Get a list of the faxes in the outbox which were not yet sent. (Allowed scopes: **fax:all:read**, **fax:fax:read**)

List faxes in the outbox

Send a fax to one or more destinations. For corporate members without a fax number assigned set the 'from' parameter to 'no_number'. (Allowed scopes: **fax:all:edit**, **fax:fax:edit**)

Send a fax

Get a list of faxes currently scheduled for sending. (Allowed scopes: **fax:all:read**, **fax:fax:read**)

List outgoing faxes

Modify an outgoing fax that is being scheduled for sending. (Allowed scopes: **fax:all:edit**, **fax:fax:edit**)

Modify an outgoing fax

Delete an outgoing fax that is being scheduled for sending. (Allowed scopes: **fax:all:edit**, **fax:fax:edit**)

Delete an outgoing fax

Returns a list of currently registered webhooks for the requested **event**. (Allowed scopes: **fax:all:read**, **fax:webhook:read**)

List user webhooks

Register a new webhook which will be called on a specific event. See the WebhookCallback model. (Allowed scopes: **fax:all:edit**, **fax:webhook:edit**)

Register new webhook

Delete a webhook by its ID. (Allowed scopes: **fax:all:edit**, **fax:webhook:edit**)

Get Started

Concepts

SDKs

API Reference

Python