Skip to content

Retrieve a Mail2Fax profile

Request

Retrieve a specifc Mail2Fax profile

Security
http-basic-auth
Path
profilestringrequired

The profile name

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

Responses

The requested Mail2Fax profile

Bodyapplication/json
namestring
generalobject(GeneralProfileSettings)
faxobject(FaxSettings)
dialingobject(DialingSettings)
reportEmailobject(ReportEmailSettings)
coverSheetobject(CoverSheetSettings)
personalizationobject
Response
{
  "name": "Retarus-USA-Sales",
  "dialing": {
    "countryCode": "+1",
    "areaCode": "201"
  },
  "reportEmail": {
    "language": "en"
  },
  "coverSheet": {
    "dateFormat": "MM/dd/yyyy",
    "timeFormat": "h:mm a"
  },
  "personalization": {
    "company": "retarus (North America) Inc."
  },
  "general": {
    "timezone": "US/Eastern"
  },
  "fax": {
    "csid": "Retarus USA",
    "costCenter": "Retarus-USA-Sales",
    "paperSize": "letter"
  }
}