Skip to content

Retrieve Mail2Fax users

Request

Retrieve Mail2Fax users

Security
http-basic-auth
Query
profilestring

Retrieve only users that are assigned to the specified profile

Example:profile=default
clientstring

Retrieve only users that are assigned to the specified client

Example:client=default
searchstring

Retrieve only users whose email address, profile or client matches the specified search string

Example:search=john.smith@retarus.com
fuzzystring

Switch between exact- and contains-match

Example:fuzzy=false
limitinteger, (int32)

Number of users to return in the response

Default:100
offsetinteger, (int32)

Retrieve users starting with the offset

Default:0
templatestring

Retrieve users with the specified coverpage template

Example:template=coverpage_us_sales.rtf
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=false&limit=100&offset=0&template=coverpage_us_sales.rtf'

Responses

#FIXME Add a description

Bodyapplication/json
Array [
emailstring
generalobject(GeneralUserSettings)
faxobject(FaxSettings)
dialingobject(DialingSettings)
reportEmailobject(ReportEmailSettings)
coverSheetobject(CoverSheetSettings)
personalizationobject
]
Response
[
  {
    "email": "john.smith@retarus.com",
    "personalization": { … },
    "general": { … },
    "fax": { … }
  },
  {
    "email": "max.mustermann@retarus.de",
    "personalization": { … },
    "general": { … },
    "fax": { … }
  }
]