Skip to content

Fax Configuration API (2.0)

The fax configuration API allows you to administer:

  • Mail to Fax
  • Fax to Email
  • Fax to FTP
  • Fax to Webservice
Download OpenAPI description
fax-config-api.json
fax-config-api.yaml
Languages
Servers
Mock server

https://developers.retarus.com/_mock/fax/fax-config-api/

Production

https://fax-config.de2.retarus.com/v2/

Inbound Fax

View and configure inbound fax numbers

Operations

Inbound Fax Profiles

View and configure inbound fax profiles

Operations

Mail to Fax

View and configure email to fax users

Operations

Mail to Fax Profiles

View and configure email to fax profiles

Operations

Joint Outbound and Inbound

Retrieve joined Mail to Fax user and Fax to Mail number

Operations

Retrieve joint fax accounts

Request

Retrieve joint fax accounts

Security
http-basic-auth
Path
correlation-idstringrequired

Retrieve inbound numbers and outbound users correlated by the specified id

Default "aecd8419-6bf4-4e17-9380-b3236297ecfa"
Example: aecd8419-6bf4-4e17-9380-b3236297ecfa
curl -i -X GET \
  -u <username>:<password> \
  https://developers.retarus.com/_mock/fax/fax-config-api/joint/accounts/aecd8419-6bf4-4e17-9380-b3236297ecfa

Responses

Voilà

Bodyapplication/jsonArray [
correlationIdstring
inboundArray of objects(InboundFaxNumber)
outboundArray of objects(MailToFaxUser)
]
Response
application/json
[
  {
    "correlationId": "string",
    "inbound": [ … ],
    "outbound": [ … ]
  }
]