etherFAX Inbox API
The Inbox API from etherFAX — 5 operation(s) for inbox.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/etherfax:etherfax-inbox-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: etherfax-rest-api-30 Inbox API
version: '3.0'
servers:
- url: https://na.connect.etherfax.net/rest/3.0/api
security:
- sec0: []
tags:
- name: Inbox
paths:
/inbox?a=get:
get:
summary: /inbox (get)
description: Gets/downloads the FaxReceive information for the specified fax {id}. All information including the FaxImage content is returned using this method.
operationId: inbox-get
parameters:
- name: a
in: query
description: Action to perform.
schema:
type: string
default: get
- name: id
in: query
description: Specifies the {id} of the <FaxReceive> object to retrieve.
schema:
type: string
- name: download
in: query
description: The download option allows the client to specify whether to include the FaxImage content when retrieving the received fax.
schema:
type: integer
format: int32
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"JobId\": \"fc00fc44-9f52-4319-82c3-a4c4ec490f0c\",\n \"FaxResult\": 0,\n \"ConnectTime\": 41,\n \"ConnectSpeed\": 33600,\n \"PagesReceived\": 1,\n \"RemoteId\": \"Pearson Medical\",\n \"CalledNumber\": \"+17325551234\",\n \"CallingNumber\": \"+1856551034\",\n \"ReceivedOn\": \"2019-01-18T15:58:34.317\",\n \"FaxImage\": null,\n \"DeviceId\": 0,\n \"TransactionType\": 1,\n \"DocumentParams\": {\n \"Type\": \"image/tiff\",\n \"Length\": 42700,\n \"Hash\": \"3db145c0f1979ec4b225de753b8c6071\",\n \"Name\": null\n }\n}"
schema:
type: object
properties:
JobId:
type: string
example: fc00fc44-9f52-4319-82c3-a4c4ec490f0c
FaxResult:
type: integer
example: 0
default: 0
ConnectTime:
type: integer
example: 41
default: 0
ConnectSpeed:
type: integer
example: 33600
default: 0
PagesReceived:
type: integer
example: 1
default: 0
RemoteId:
type: string
example: Pearson Medical
CalledNumber:
type: string
example: '+17325551234'
CallingNumber:
type: string
example: '+1856551034'
ReceivedOn:
type: string
example: '2019-01-18T15:58:34.317'
FaxImage: {}
DeviceId:
type: integer
example: 0
default: 0
TransactionType:
type: integer
example: 1
default: 0
DocumentParams:
type: object
properties:
Type:
type: string
example: image/tiff
Length:
type: integer
example: 42700
default: 0
Hash:
type: string
example: 3db145c0f1979ec4b225de753b8c6071
Name: {}
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Inbox
/inbox?a=getnext:
get:
summary: /inbox (getnext)
description: Gets and optionally downloads the next unread fax (if one is available) and returns the FaxReceive information. The {download} parameter may be set to 1 or 0 when using this function. This function is designed for multi-process environments that attempt to receive a fax using the same account. To resolve contention, only one peer may gain access to an unread fax at a time. If the peer fails to download the fax and mark it as received within a 5-minute window, the automatic lock on the fax is released and another peer may download the unread fax. Additionally, the peer may also set the {sid} parameter which is a GUID representing the site-id. etherFAX will record the site id responsible for downloading the fax document.
operationId: inbox-getnext
parameters:
- name: a
in: query
description: Action to perform.
schema:
type: string
default: getnext
- name: download
in: query
description: (Optional) Indicates whether the FaxImage content should be downloaded in the response.
schema:
type: integer
format: int32
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"JobId\": \"fc00fc44-9f52-4319-82c3-a4c4ec490f0c\",\n \"FaxResult\": 0,\n \"ConnectTime\": 41,\n \"ConnectSpeed\": 33600,\n \"PagesReceived\": 1,\n \"RemoteId\": \"Pearson Medical\",\n \"CalledNumber\": \"+17325551234\",\n \"CallingNumber\": \"+1856551034\",\n \"ReceivedOn\": \"2019-01-18T15:58:34.317\",\n \"FaxImage\": null,\n \"DeviceId\": 0,\n \"TransactionType\": 1,\n \"DocumentParams\": {\n \"Type\": \"image/tiff\",\n \"Length\": 42700,\n \"Hash\": \"3db145c0f1979ec4b225de753b8c6071\",\n \"Name\": null\n }\n}"
schema:
type: object
properties:
JobId:
type: string
example: fc00fc44-9f52-4319-82c3-a4c4ec490f0c
FaxResult:
type: integer
example: 0
default: 0
ConnectTime:
type: integer
example: 41
default: 0
ConnectSpeed:
type: integer
example: 33600
default: 0
PagesReceived:
type: integer
example: 1
default: 0
RemoteId:
type: string
example: Pearson Medical
CalledNumber:
type: string
example: '+17325551234'
CallingNumber:
type: string
example: '+1856551034'
ReceivedOn:
type: string
example: '2019-01-18T15:58:34.317'
FaxImage: {}
DeviceId:
type: integer
example: 0
default: 0
TransactionType:
type: integer
example: 1
default: 0
DocumentParams:
type: object
properties:
Type:
type: string
example: image/tiff
Length:
type: integer
example: 42700
default: 0
Hash:
type: string
example: 3db145c0f1979ec4b225de753b8c6071
Name: {}
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Inbox
/inbox?a=list:
get:
summary: /inbox (list)
description: Returns a list of unread faxes for the given account. All faxes are returned as FaxReceive child nodes in the response. The optional {count} value may be specified to limit the number of unread faxes returned in the list. Setting this value to 0 (or omitted) returns all unread faxes. This function only returns the information associated with the received fax and not the actual fax image data.
operationId: inbox-list
parameters:
- name: a
in: query
description: Action to perform.
schema:
type: string
default: list
- name: count
in: query
description: (Optional) Limits the returned results to the count specified.
schema:
type: integer
format: int32
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "[\n {\n \"JobId\": \"fc00fc44-9f52-4319-82c3-a4c4ec490f0c\",\n \"FaxResult\": 0,\n \"ConnectTime\": 41,\n \"ConnectSpeed\": 33600,\n \"PagesReceived\": 1,\n \"RemoteId\": \"Pearson Medical\",\n \"CalledNumber\": \"+17325551234\",\n \"CallingNumber\": \"+1856551034\",\n \"ReceivedOn\": \"2019-01-18T15:58:34.317\",\n \"FaxImage\": null,\n \"DeviceId\": 0,\n \"TransactionType\": 1,\n \"DocumentParams\": {\n \"Type\": \"image/tiff\",\n \"Length\": 42700,\n \"Hash\": \"3db145c0f1979ec4b225de753b8c6071\",\n \"Name\": null\n }\n }\n]"
schema:
type: array
items:
type: object
properties:
JobId:
type: string
example: fc00fc44-9f52-4319-82c3-a4c4ec490f0c
FaxResult:
type: integer
example: 0
default: 0
ConnectTime:
type: integer
example: 41
default: 0
ConnectSpeed:
type: integer
example: 33600
default: 0
PagesReceived:
type: integer
example: 1
default: 0
RemoteId:
type: string
example: Pearson Medical
CalledNumber:
type: string
example: '+17325551234'
CallingNumber:
type: string
example: '+1856551034'
ReceivedOn:
type: string
example: '2019-01-18T15:58:34.317'
FaxImage: {}
DeviceId:
type: integer
example: 0
default: 0
TransactionType:
type: integer
example: 1
default: 0
DocumentParams:
type: object
properties:
Type:
type: string
example: image/tiff
Length:
type: integer
example: 42700
default: 0
Hash:
type: string
example: 3db145c0f1979ec4b225de753b8c6071
Name: {}
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Inbox
/inbox?a=received:
get:
summary: /inbox (received)
description: Marks the specified fax {id} as "received" indicating that it has been successfully read or delivered. Once an application has guaranteed that it has received the fax intact, it should mark the fax as received, thus permanently removing the fax image resource.
operationId: inbox-received
parameters:
- name: a
in: query
description: Action to perform.
schema:
type: string
default: received
- name: id
in: query
description: Specifies the unique job id to mark as read.
schema:
type: string
- name: res
in: query
description: (Optional) If the receiver cannot download/process a received fax, an extended result code may be provided to indicate a specific condition.
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Inbox
/inbox?a=unread:
get:
summary: /inbox (unread)
description: Returns the number of unread fax events for the given account. When using the unread action, you may optionally provide the wait timeout value to wait for a new fax.
operationId: inbox-unread
parameters:
- name: a
in: query
description: Action to perform.
schema:
type: string
default: unread
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"UnreadFaxes\": 0\n}"
schema:
type: object
properties:
UnreadFaxes:
type: integer
example: 0
default: 0
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Inbox
components:
securitySchemes:
sec0:
type: http
scheme: basic
x-readme-fauxas: true
x-provenance:
method: searched
source: https://docs.etherfax.net/reference
harvested: '2026-10-26'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://docs.etherfax.net/reference/accounts-pkino.md
- https://docs.etherfax.net/reference/accounts.md
- https://docs.etherfax.net/reference/devices-actionreset.md
- https://docs.etherfax.net/reference/devices-list.md
- https://docs.etherfax.net/reference/devices-pkinfo.md
- https://docs.etherfax.net/reference/devices-register.md
- https://docs.etherfax.net/reference/devices-setaddr.md
- https://docs.etherfax.net/reference/devices-setconfig.md
- https://docs.etherfax.net/reference/devices-status.md
- https://docs.etherfax.net/reference/devices-unread.md
- https://docs.etherfax.net/reference/inbox-get.md
- https://docs.etherfax.net/reference/inbox-getnext.md
- https://docs.etherfax.net/reference/inbox-list.md
- https://docs.etherfax.net/reference/inbox-received.md
- https://docs.etherfax.net/reference/inbox-unread.md
- https://docs.etherfax.net/reference/outbox-pending.md
- https://docs.etherfax.net/reference/outbox.md
- https://docs.etherfax.net/reference/routes-enable.md
- https://docs.etherfax.net/reference/routes-info.md
- https://docs.etherfax.net/reference/routes-list.md
- https://docs.etherfax.net/reference/routes-parse.md
- https://docs.etherfax.net/reference/status-post.md
- https://docs.etherfax.net/reference/status.md
merge:
pages: 23
deduped: 22
conflicts_kept_first: 0