View and configure inbound fax numbers
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
Languages
Servers
Mock server
https://developers.retarus.com/_mock/fax/fax-config-api/
Production
https://fax-config.de2.retarus.com/v2/
- Mock server
https://developers.retarus.com/_mock/fax/fax-config-api/outbound/users/{user}
- Production
https://fax-config.de2.retarus.com/v2/outbound/users/{user}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://developers.retarus.com/_mock/fax/fax-config-api/outbound/users/john.smith@retarus.comResponse
application/json
A typical Mail2Fax user with only a user specific cost center and a few personalization values
{ "email": "john.smith@retarus.com", "personalization": { "department": "Sales", "title": "Sales Representative" }, "general": { "client": "default", "profile": "default" }, "fax": { "costCenter": "Sales-USA" } }
- Mock server
https://developers.retarus.com/_mock/fax/fax-config-api/outbound/users/{user}
- Production
https://fax-config.de2.retarus.com/v2/outbound/users/{user}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://developers.retarus.com/_mock/fax/fax-config-api/outbound/users/john.smith@retarus.com \
-H 'Content-Type: application/json' \
-d '{
"personalization": {
"department": "Sales",
"title": "Sales Representative"
},
"general": {
"client": "default",
"profile": "default",
"active": true
},
"fax": {
"costCenter": "Sales-USA"
}
}'- Mock server
https://developers.retarus.com/_mock/fax/fax-config-api/outbound/users/{user}
- Production
https://fax-config.de2.retarus.com/v2/outbound/users/{user}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://developers.retarus.com/_mock/fax/fax-config-api/outbound/users/john.smith@retarus.com- Mock server
https://developers.retarus.com/_mock/fax/fax-config-api/outbound/users/{user}
- Production
https://fax-config.de2.retarus.com/v2/outbound/users/{user}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
-u <username>:<password> \
https://developers.retarus.com/_mock/fax/fax-config-api/outbound/users/john.smith@retarus.com \
-H 'Content-Type: application/json-patch+json' \
-d '{
"path": "/fax",
"value": {
"costCenter": "Retarus-Sales-USA"
},
"op": "add"
}'- Mock server
https://developers.retarus.com/_mock/fax/fax-config-api/outbound/users
- Production
https://fax-config.de2.retarus.com/v2/outbound/users
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://developers.retarus.com/_mock/fax/fax-config-api/outbound/users?profile=default&client=default&search=john.smith%40retarus.com&fuzzy=string&limit=100&offset=0&template=coverpage_us_sales.rtf'Response
application/json
[ { "email": "john.smith@retarus.com", "personalization": { … }, "general": { … }, "fax": { … } }, { "email": "max.mustermann@retarus.de", "personalization": { … }, "general": { … }, "fax": { … } } ]