Skip to content

Retrieve a Mail2Fax user

Request

Retrieve a Mail2Fax user

Security
http-basic-auth
Path
userstringrequired

The users email address

Example:john.smith@retarus.com
curl -i -X GET \
  -u '<username>:<password>' \
  https://developers.retarus.com/_mock/fax/fax-config-api/outbound/users/john.smith@retarus.com

Responses

The configuration for the requested Mail2Fax user

Bodyapplication/json
emailstring
generalobject(GeneralUserSettings)
faxobject(FaxSettings)
dialingobject(DialingSettings)
reportEmailobject(ReportEmailSettings)
coverSheetobject(CoverSheetSettings)
personalizationobject
Response
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"
  }
}