Skip to content

Retrieve inbound profile configurations

Request

Retrieve inbound fax profile configurations.

Security
http-basic-auth
Query
inheritboolean

Toggle whether to show inherited fields

Default:false
serviceTypestring(InboundProfileServiceType)
Enum:"Fax2Mail""Fax2WS""Fax2FTP"
namestring
Example:name=Fax2Mail USA
curl -i -X GET \
  -u '<username>:<password>' \
  'https://developers.retarus.com/_mock/fax/fax-config-api/inbound/profiles?inherit=false&serviceType=Fax2Mail&name=Fax2Mail%20USA'

Responses

List of inbound fax profiles

Bodyapplication/json
Array [
namestring
serviceTypestring(InboundProfileServiceType)
Enum:"Fax2Mail""Fax2WS""Fax2FTP"
]
Response
[
  {
    "name": "Fax2FTP Orders",
    "serviceType": "Fax2FTP"
  },
  {
    "name": "Fax2WS Lab Reports",
    "serviceType": "Fax2WS"
  },
  {
    "name": "Fax2Mail USA",
    "serviceType": "Fax2Mail"
  }
]