API Documentation > REST API

REST API

Overview

The InterFAX REST API is a subscription-based commercial service, which enables the transmission and reception of fax messages, without the need to install any hardware or software.

The InterFAX API provides facilities for retrieving status updates for the messages sent through it, and supports secure communications via HTTPS between custom-programmed applications and the InterFAX servers.

If you would like to use our advanced security REST PCI API (compliant with PCI-DSS), please see the reference section here.

REST API Conventions

REST API Endpoint	Data Formats	Authentication
System Limitations	Request Formats	Help Tools
Supported File Types	Response Formats

REST API Integrations

Salesforce Classic
Salesforce Lightning
Migrating From Twilio

Available operations & resources

Sending Faxes	Other Outbound	PCI REST API
Sending fax batches	Receiving faxes	REST API Index
Uploading documents	Receiving documents

Sending faxes

More information

Operation & Resource	Description
`POST /outbound/faxes`	Submit a fax to a single destination number.
`GET /outbound/faxes`	Get a list of recent outbound faxes (which does not include batch faxes).
`GET /outbound/faxes/completed`	Get details for a subset of completed faxes from a submitted list. (Submitted ID’s which have not completed are ignored).
`GET /outbound/faxes/{id}`	Retrieves information regarding a previously-submitted fax, including its current status.
`GET /outbound/faxes/{id}/image`	Retrieve the fax image (TIFF file) of a submitted fax.
`POST /outbound/faxes/{id}/cancel`	Cancel a fax in progress.
`POST /outbound/faxes/{id}/resend`	Resend a previously-submitted fax, without needing to re-upload the original document.
`POST /outbound/faxes/{id}/hide`	Hide a fax from listing in queries (there is no way to unhide a fax).
`GET /outbound/sendingprofile`	Retrieves the outbound sending user’s profile.
`GET /outbound/contacts/{id}`	Retrieves the contacts of a list.
`GET /outbound/help/mediatype`	Determine accepted mediatypes and file formats.

Sending fax batches

More information

Operation & Resource	Description
`POST /outbound/batches`	Submit one or more documents for batch-faxing to multiple recipients.
`GET /outbound/batches`	Retrieve a list of outbound batches.
`GET /outbound/batches/{id}`	Retrieve information regarding a previously-submitted batch, including its completion statistics.
`GET /outbound/batches/{id}/children`	Retrieve information about a batch’s individual transactions.
`GET /outbound/batches/{id}/image`	Retrieve the fax image (TIFF file) of a submitted batch.
`GET /outbound/batches/{id}/resend`	Resubmit a batch. Usually used to resubmit failed faxes only, to give them another try.
`GET /outbound/batches/{id}/cancel`	Cancel a batch in progress.
`GET /outbound/batches/{id}/hide`	Hide a batch from listing in queries. (There is no way to unhide a transaction). Hiding a batch also hides all its child faxes.
`GET /outbound/addressbooks`	Retrieve a list of distribution lists, to which batches may be sent. For more information please see the reference section – here.

Other Outbound

Operation & Resource	Description
`GET /outbound/search`	Search for individual faxes as well as child faxes of batches.
`GET /accounts/self/ppcards/balance`	Determine the remaining faxing credits in your account.

Uploading documents

More information

Operation & Resource	Description
`POST /outbound/documents`	Create a document upload session.
`POST /outbound/documents/{id}`	Upload a chunk to an existing document upload session.
`GET /outbound/documents`	Get a list of previous document uploads which are currently available.
`GET /outbound/documents/{id}`	Get the current status of a specific document upload.
`DELETE /outbound/documents/{id}`	Cancel a document upload and tear down the upload session, or delete a previous upload.

Receiving faxes

More information

Operation & Resource	Description
`GET /inbound/faxes`	Retrieves a user’s list of inbound faxes. (Sort order is always in descending ID).
`GET /inbound/faxes/{id}`	Retrieves a single fax’s metadata (receive time, sender number, etc.).
`GET /inbound/faxes/{id}/image`	Retrieves a single fax’s image.
`GET /inbound/faxes/{id}/emails`	Retrieve the list of email addresses to which a fax was forwarded.
`POST /inbound/faxes/{id}/mark`	Mark a transaction as read/unread.
`POST /inbound/faxes/{id}/resend`	Resend an inbound fax to a specific email address.

Receiving documents

More information

Operation & Resource	Description
`GET /documents/search`	Retrieves a list of documents for the user.
`PUT /documents/tag`	Creates a new tag for a user.
`PUT /documents/tagging/{TAG}`	Adds a tag to a single document or multiple documents.
`GET /documents/tags/{ID}`	Retrieves all the tags of a selected document.
`GET /documents/tags`	Retrieves all the tags of a selected user.
`GET documents/auto/tags/{INFIX}`	Retrieves all the values of a selected tag (of a single user).
`PATCH /documents/tag/{TAG}?Newtag={NEWTAG}`	Renames an existing tag for a User.
`DELETE /documents/tag/{TAG}`	Deletes an existing tag for a User.
`DELETE /documents/tagging/{TAG}`	Removes a tag from a single document or multiple documents.
`GET /documents/auto/customized/{ID}/{INFIX}`	Retrieves all the values of a selected customized property (of a single account).
`POST /documents/search`	Retrieves list of documents for the user using JSON.