API Reference

Overview

User
User Faxes
User Contacts
Send Fax
Preview Fax
Resellers
Accounts
Users
Numbers
Contacts
Locations
Devices
Subscriptions

User

Get Current User Info

GET /api/v2/me

User Faxes

List User Incoming Faxes

GET /api/v2/me/incoming-faxes

Query Parameters:

Parameter	Type	Required	Description
number	string	No	Filter by number (numeric characters only)
fax_status	string	No	Filter by status

GET /api/v2/me/incoming-faxes/{incomingFaxId}

Get User Incoming Fax

GET /api/v2/me/incoming-faxes/{incomingFaxId}

Delete User Incoming Fax

DELETE /api/v2/me/incoming-faxes/{incomingFaxId}

List User Outgoing Faxes

GET /api/v2/me/outgoing-faxes

Query Parameters:

Parameter	Type	Required	Description
number	string	No	Filter by number (numeric characters only)
fax_status	string	No	Filter by status

GET /api/v2/me/outgoing-faxes/{outgoingFaxId}

Get User Outgoing Fax

GET /api/v2/me/outgoing-faxes/{outgoingFaxId}

Delete User Outgoing Fax

DELETE /api/v2/me/outgoing-faxes/{outgoingFaxId}

User Contacts

List User Contacts

GET /api/v2/me/contacts

Create User Contact

POST /api/v2/me/contacts

Body:

Parameter	Type	Required	Description
name	string	Yes	Contact name (max 255 characters)
country	string	Yes	Country code e.g `US`
number	string	Yes	Phone number

Get User Contact

GET /api/v2/me/contacts/{contactId}

Update User Contact

PUT /api/v2/me/contacts/{contactId}

Body:

Parameter	Type	Required	Description
name	string	Yes	Contact name (max 255 characters)
country	string	Yes	Country code e.g `US`
number	string	Yes	Phone number

Delete User Contact

DELETE /api/v2/me/contacts/{contactId}

Send Fax

Roles: All users

POST /api/v2/me/send-fax

Body:

Parameter	Type	Required	Description
from_number	string	Yes	Number to send fax from
to_number	string[]	Yes	Fax recipient number(s), max 4 if multiple
fax_file	file[]	Yes	Document to fax (max 25MB, PDF/JPG/PNG/DOC/DOCX)
user_cover_page_is_enable	boolean	No	Enable user cover page
recipient_name	string	No	Recipient name
cover_page_from_name	string	No	Cover page from name
cover_letter_body	string	No	Cover letter body

Preview Fax

Roles: All users

This endpoint returns a temporary URL to preview a fax.

Preview Fax

GET /api/v2/{faxType}/{id}/preview

Path Parameters:

Parameter	Type	Required	Description
faxType	string	Yes	Fax type (`incoming-faxes`, `outgoing-faxes`)
id	string	Yes	Fax ID

Resellers

Roles: Reseller Admin

List Resellers

GET /api/v2/resellers

Create Reseller

POST /api/v2/resellers

Body:

Parameter	Type	Required	Description
name	string	Yes	Reseller name (max 255 characters, unique)
sub_domain	string	Yes	Subdomain (max 255 characters, unique)
primary_color	string	No	Interface primary color (max 255 characters)
page_title_text	string	No	Page title text (max 255 characters)
footer_text	string	No	Footer text (max 255 characters)
forgot_password_text	string	No	Forgot password text (max 255 characters)
enable_forgot_password	boolean	No	Enable forgot password feature
timezone	string	No	Timezone (max 255 characters)
show_failed_incoming_faxes	boolean	No	Show failed incoming faxes
api_enabled	boolean	No	Enable API
fax_retries	integer	No	Fax retries (max 10)
fax_retry_interval	integer	No	Fax retry interval (minutes)
fax_quality	string	No	Fax quality (`low`, `medium`, `high`, `black_and_white`)

Get Reseller

GET /api/v2/resellers/{resellerId}

Update Reseller

PUT /api/v2/resellers/{resellerId}

Body:

Parameter	Type	Required	Description
name	string	Yes	Reseller name (max 255 characters, unique)
primary_color	string	No	Interface primary color (max 255 characters)
page_title_text	string	No	Page title text (max 255 characters)
footer_text	string	No	Footer text (max 255 characters)
forgot_password_text	string	No	Forgot password text (max 255 characters)
enable_forgot_password	boolean	No	Enable forgot password feature
timezone	string	No	Timezone (max 255 characters)
show_failed_incoming_faxes	boolean	No	Show failed incoming faxes
api_enabled	boolean	No	Enable API
fax_retries	integer	No	Fax retries (max 10)
fax_retry_interval	integer	No	Fax retry interval (minutes)
fax_quality	string	No	Fax quality (`low`, `medium`, `high`, `black_and_white`)

Delete Reseller

DELETE /api/v2/resellers/{resellerId}

Accounts

Roles: Reseller Admin, Account Admin, Multi-Account Admin

List Accounts

GET /api/v2/resellers/{resellerId}/accounts

Create Account

POST /api/v2/resellers/{resellerId}/accounts

Body:

Parameter	Type	Required	Description
name	string	Yes	Account name
api_enabled	boolean	No	Enable API
timezone	string	No	Timezone (max 255 characters)
ns_domain	string	No	NetSapiens domain (max 255 characters)
is_enable	boolean	No	Enable account
enable_delete_fax	boolean	No	Enable fax deletion
force_secure_fax_password	boolean	No	Force secure fax password
enable_custom_header_info	boolean	No	Enable custom header info
enable_seven_digit_dialing	boolean	No	Enable seven-digit dialing
enable_custom_confirmation_page	boolean	No	Enable custom confirmation page
enable_custom_confirmation_page_thumbnail	boolean	No	Enable custom confirmation thumbnail
cover_page	boolean	No	Enable cover page
fax_retries	integer	No	Fax retries
fax_retry_interval	integer	No	Fax retry interval (minutes)
fax_quality	string	No	Fax quality (`low`, `medium`, `high`, `black_and_white`)
enable_international_dialing	boolean	No	Enable international dialing

Get Account

GET /api/v2/resellers/{resellerId}/accounts/{accountId}

Update Account

PUT /api/v2/resellers/{resellerId}/accounts/{accountId}

Body:

Parameter	Type	Required	Description
name	string	Yes	Account name
api_enabled	boolean	No	Enable API
timezone	string	No	Timezone (max 255 characters)
ns_domain	string	No	NetSapiens domain (max 255 characters)
is_enable	boolean	No	Enable account
enable_delete_fax	boolean	No	Enable fax deletion
force_secure_fax_password	boolean	No	Force secure fax password
enable_custom_header_info	boolean	No	Enable custom header info
enable_seven_digit_dialing	boolean	No	Enable seven-digit dialing
enable_custom_confirmation_page	boolean	No	Enable custom confirmation page
enable_custom_confirmation_page_thumbnail	boolean	No	Enable custom confirmation thumbnail
cover_page	boolean	No	Enable cover page
fax_retries	integer	No	Fax retries
fax_retry_interval	integer	No	Fax retry interval (minutes)
fax_quality	string	No	Fax quality (`low`, `medium`, `high`, `black_and_white`)
enable_international_dialing	boolean	No	Enable international dialing

Delete Account

DELETE /api/v2/resellers/{resellerId}/accounts/{accountId}

Users

Roles: Reseller Admin

List Users

GET /api/v2/accounts/{accountId}/users

Create User

POST /api/v2/accounts/{accountId}/users

Body:

Parameter	Type	Required	Description
name	string	Yes	User name
email	string	Yes	User email
password	string	No	User password
role	string	Yes	User role (`Basic User`, `Location Admin`, `Account Admin`, `Multi-Account Admin`, `Reseller Admin`)
location_id	string	No	Location ID
notes	string	No	Notes
fax_quality	string	No	Fax quality (`low`, `medium`, `high`, `black_and_white`)
is_enable	boolean	No	Enable user
api_enabled	boolean	No	Enable API
enable_portal	boolean	No	Enable portal access
account_ids	array	No	Account IDs

Get User

GET /api/v2/accounts/{accountId}/users/{userId}

Update User

PUT /api/v2/accounts/{accountId}/users/{userId}

Body:

Parameter	Type	Required	Description
name	string	Yes	User name
email	string	Yes	User email
password	string	No	User password
role	string	Yes	User role (`Basic User`, `Location Admin`,`Account Admin`, `Multi-Account Admin`, `Reseller Admin`)
location_id	string	No	Location ID
notes	string	No	Notes
fax_quality	string	No	Fax quality (`low`, `medium`, `high`, `black_and_white`)
is_enable	boolean	No	Enable user
api_enabled	boolean	No	Enable API
enable_portal	boolean	No	Enable portal access
account_ids	array	No	Account IDs

Delete User

DELETE /api/v2/accounts/{accountId}/users/{userId}

Numbers

Roles: Reseller Admin, Account Admin, Multi-Account Admin, Location Admin

List Numbers

GET /api/v2/accounts/{accountId}/numbers

Create Number

POST /api/v2/accounts/{accountId}/numbers

Body:

Parameter	Type	Required	Description
country	string	Yes	Country code
number	string	Yes	Phone number (unique, valid for country)
description	string	No	Description (max 255 characters)
location_id	string	No	Location ID
is_enable	boolean	No	Enable number
company_name	string	No	Company name (max 255 characters, alphanumeric with spaces)
caller_id	string	No	Caller ID (max 255 characters)
secure_fax_mode	boolean	No	Enable secure fax mode
allow_on_net	boolean	No	Allow on-net faxing

Get Number

GET /api/v2/accounts/{accountId}/numbers/{numberId}

Update Number

PUT /api/v2/accounts/{accountId}/numbers/{numberId}

Body:

Parameter	Type	Required	Description
number	string	Yes	Phone number (unique, valid for country)
description	string	No	Description (max 255 characters)
location_id	string	No	Location ID
is_enable	boolean	No	Enable number
company_name	string	No	Company name (max 255 characters, alphanumeric with spaces)
caller_id	string	No	Caller ID (max 255 characters)
secure_fax_mode	boolean	No	Enable secure fax mode
allow_on_net	boolean	No	Allow on-net faxing

Delete Number

DELETE /api/v2/accounts/{accountId}/numbers/{numberId}

Get Number Users

GET /api/v2/accounts/{accountId}/numbers/{numberId}/users

Update Number Users

PUT /api/v2/accounts/{accountId}/numbers/{numberId}/users

Body:

Parameter	Type	Required	Description
users	object[]	Yes	List of users to assign/update for this number
users.*.user_id	string\|number	Yes	User ID (must exist and belong to account)
users.*.settings	object	Yes	Settings for the user on this number
users.*.settings.incoming	object	Yes	Incoming fax settings
users.*.settings.incoming.incoming	boolean	Yes	Enable incoming fax
users.*.settings.incoming.email_notification	string	Yes	Incoming fax email notification (`All`, `Success`, `Failed`, `Disabled`)
users.*.settings.incoming.include_attachment	boolean	Yes	Include incoming fax as attachment
users.*.settings.outgoing	object	Yes	Outgoing fax settings
users.*.settings.outgoing.outgoing	boolean	Yes	Enable outgoing fax
users.*.settings.outgoing.view_all_outgoing	boolean	Yes	Can view all outgoing faxes on this number
users.*.settings.outgoing.email_notification	string	Yes	Outgoing fax email notification (`All`, `Success`, `Failed`, `Disabled`)
users.*.settings.outgoing.include_attachment	boolean	Yes	Include outgoing fax as attachment

Contacts

Roles: Reseller Admin, Account Admin, Multi-Account Admin

List Contacts

GET /api/v2/accounts/{accountId}/contacts

Create Contact

POST /api/v2/accounts/{accountId}/contacts

Body:

Parameter	Type	Required	Description
location_id	string	No	Location of the contact
name	string	Yes	Contact name (max 255 characters)
country	string	Yes	Country code
number	string	Yes	Phone number

Get Contact

GET /api/v2/accounts/{accountId}/contacts/{contactId}

Update Contact

PUT /api/v2/accounts/{accountId}/contacts/{contactId}

Body:

Parameter	Type	Required	Description
location_id	string	No	Location of the contact
name	string	Yes	Contact name (max 255 characters)
country	string	Yes	Country code
number	string	Yes	Phone number

Delete Contact

DELETE /api/v2/accounts/{accountId}/contacts/{contactId}

Locations

Roles: Reseller Admin, Account Admin, Multi-Account Admin

List Locations

GET /api/v2/accounts/{accountId}/locations

Create Location

POST /api/v2/accounts/{accountId}/locations

Body:

Parameter	Type	Required	Description
name	string	Yes	Location name (max 255 characters)

Get Location

GET /api/v2/accounts/{accountId}/locations/{locationId}

Update Location

PUT /api/v2/accounts/{accountId}/locations/{locationId}

Body:

Parameter	Type	Required	Description
name	string	Yes	Location name (max 255 characters)

Delete Location

DELETE /api/v2/accounts/{accountId}/locations/{locationId}

Devices

Roles: Reseller Admin, Multi-Account Admin, Account Admin, Location Admin

List Device Types

GET /api/v2/device-types

List Devices

GET /api/v2/accounts/{accountId}/devices

Create Device

POST /api/v2/accounts/{accountId}/devices

Body:

Parameter	Type	Required	Description
device_type_id	integer	Yes	Device type ID
mac	string	Yes	MAC address (valid, unique)
serial	string	Yes	Serial number (max 255 characters)
is_enabled	boolean	No	Enable device
notes	string	No	Notes (alphanumeric with spaces, max 255 characters)
username	string	Conditional	Required unless manufacturer is FaxEdge (unique, string)
password	string	Conditional	Required unless manufacturer is FaxEdge (4–255 characters)

Get Device

GET /api/v2/accounts/{accountId}/devices/{deviceId}

Update Device

PUT /api/v2/accounts/{accountId}/devices/{deviceId}

Body:

Parameter	Type	Required	Description
device_type_id	integer	Yes	Device type ID
mac	string	No	MAC address (valid, unique)
serial	string	No	Serial number (max 255 characters)
is_enabled	boolean	No	Enable device
notes	string	No	Notes (alphanumeric with spaces, max 255 characters)
username	string	No	Required unless manufacturer is FaxEdge (unique, string)
password	string	No	Required unless manufacturer is FaxEdge (4–255 characters)

Delete Device

DELETE /api/v2/accounts/{accountId}/devices/{deviceId}

Update Device Ports

PUT /api/v2/accounts/{accountId}/devices/{deviceId}/device-ports/{devicePortId}

Body:

Parameter	Type	Required	Description
number_id	integer	Yes	Default number to send faxes from
is_enable	boolean	No	Enable port
from_name	string	No	From name (max 255 characters)
confirm_on_send	string	No	Notification on (`all`, `success`, `failed`, `disabled`)
deliver_inbound	boolean	No	Deliver inbound faxes
numbers	integer[]	No	List of numbers IDs to assign to this port
users	integer[]	No	List of users IDs to assign to this port

Subscriptions

Roles: All users

Manage webhook subscriptions to receive real-time notifications for incoming and outgoing faxes.

Get Subscriptions

GET /api/v2/subscriptions

Create Subscription

POST /api/v2/subscriptions

Body:

Parameter	Type	Required	Description
callback_url	string	yes	Callback url (max 255 characters)
expires_at	datetime	Yes	Subscription Expiry Date. The format is (YYYY-MM-DD HH:MM:SS) in UTC timezone
secret	string	no	Secret key if you want to make sure the webhook is coming from FaxEdge
type	string	yes	Type of webhook (incoming_fax, outgoing_fax)

Delete Subscription

DELETE /api/v2/subscriptions/{subscriptionId}

On this page