Skip to content

Retrieve Mail2Fax profiles

Request

Retrieve Mail2Fax profiles.

Security
http-basic-auth
Query
limitinteger, (int32)

Limit the amount of profiles returned

Default:100
offsetinteger, (int32)

Skip the specified amount of profiles #FIXME

Default:0
curl -i -X GET \
  -u '<username>:<password>' \
  'https://developers.retarus.com/_mock/fax/fax-config-api/outbound/profiles?limit=100&offset=0'

Responses

List of Mail2Fax profiles matching the search criteria

Bodyapplication/json
Array [
namestring
generalobject(GeneralProfileSettings)
faxobject(FaxSettings)
dialingobject(DialingSettings)
reportEmailobject(ReportEmailSettings)
coverSheetobject(CoverSheetSettings)
personalizationobject
]
Response
[
  {
    "name": "Retarus-USA-Sales",
    "dialing": { … },
    "reportEmail": { … },
    "coverSheet": { … },
    "personalization": { … },
    "general": { … },
    "fax": { … }
  },
  {
    "name": "Retarus-DE-Sales",
    "dialing": { … },
    "reportEmail": { … },
    "coverSheet": { … },
    "personalization": { … },
    "general": { … },
    "fax": { … }
  }
]