{"items":[{"type":"separator","label":"Sending Fax API"},{"type":"link","label":"Faxolution for Applications (Fax4A) REST API","link":"/fax/fax4a-api","routeSlug":"/fax/fax4a-api"},{"type":"group","label":"Fax jobs","link":"/fax/fax4a-api/fax-jobs","routeSlug":"/fax/fax4a-api/fax-jobs","items":[{"label":"Send a fax","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax4a-api/fax-jobs/sendjobrequest","routeSlug":"/fax/fax4a-api/fax-jobs/sendjobrequest","metadata":{"seo":{"title":"Send a fax","description":"This method is used to prepare fax jobs to be transferred for processing. If a valid FaxJobRequest has been received by the Webservice, the Webservice sends a Job ID back that must be specified by the client when querying the job status."}},"httpPath":"/{custNr}/fax"}]},{"type":"group","label":"Fax reports","link":"/fax/fax4a-api/fax-reports","routeSlug":"/fax/fax4a-api/fax-reports","items":[{"label":"Fetch the status report for a single job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax4a-api/fax-reports/getstatusreport","routeSlug":"/fax/fax4a-api/fax-reports/getstatusreport","metadata":{"seo":{"title":"Fetch the status report for a single job","description":"With the assistance of this URL resource, a status report for a fax jobcan be requested by jobId."}},"httpPath":"/{custNr}/fax/reports/{jobId}"},{"label":"Delete the status report for a single job","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax4a-api/fax-reports/deletestatusreport","routeSlug":"/fax/fax4a-api/fax-reports/deletestatusreport","metadata":{"seo":{"title":"Delete the status report for a single job","description":"Deletes the status report for a single job. Returns the Job ID."}},"httpPath":"/{custNr}/fax/reports/{jobId}"},{"label":"Fetch available status reports for this account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax4a-api/fax-reports/getallstatusreports","routeSlug":"/fax/fax4a-api/fax-reports/getallstatusreports","metadata":{"seo":{"title":"Fetch available status reports for this account","description":"This URL returns a list of available status reports for completed faxjobs for the current account."}},"httpPath":"/{custNr}/fax/reports"},{"label":"Perform bulk operations on the status reports","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax4a-api/fax-reports/bulkstatusreports","routeSlug":"/fax/fax4a-api/fax-reports/bulkstatusreports","metadata":{"seo":{"title":"Perform bulk operations on the status reports","description":"It is possible to perform bulk operations on the status reports through aPOST on the /{custNr}/fax/reports endpoint. The required parameters are:"}},"httpPath":"/{custNr}/fax/reports"},{"label":"Delete the oldest status reports for this account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax4a-api/fax-reports/deleteoldeststatusreports","routeSlug":"/fax/fax4a-api/fax-reports/deleteoldeststatusreports","metadata":{"seo":{"title":"Delete the oldest status reports for this account","description":"Deletes up to 1000 status reports for completed fax jobs for the currentaccount, starting from the oldest ones. It returns the jobIds of deletedjob reports."}},"httpPath":"/{custNr}/fax/reports"}]},{"type":"separator","label":"Status Push API"},{"type":"link","label":"Faxolution for Applications status push notification API","link":"/fax/status-push-api","routeSlug":"/fax/status-push-api"},{"type":"group","label":"status push","link":"/fax/status-push-api/status-push","routeSlug":"/fax/status-push-api/status-push","items":[{"label":"Send a status push message to the URL of your choice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/status-push-api/status-push/paths/~1your~1desired~1path/post","routeSlug":"/fax/status-push-api/status-push/paths/~1your~1desired~1path/post","metadata":{"seo":{"title":"Send a status push message to the URL of your choice","description":"Notification via HTTP implies the customer is operating an HTTP server that accepts the specified URL HTTP POST requests from Retarus' infrastructure. The customer should provide and configure:"}},"httpPath":"/your/desired/path"}]},{"type":"separator","label":"Receiving Fax API"},{"type":"link","label":"Fax2WSPull","link":"/fax/fax2ws-pull-api","routeSlug":"/fax/fax2ws-pull-api"},{"type":"group","label":"Fax2WSPull Client","link":"/fax/fax2ws-pull-api/fax2wspull-client","routeSlug":"/fax/fax2ws-pull-api/fax2wspull-client","items":[{"label":"Retrieve fax jobs from a topic and confirm the receipt.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax2ws-pull-api/fax2wspull-client/pollfaxinformation","routeSlug":"/fax/fax2ws-pull-api/fax2wspull-client/pollfaxinformation","metadata":{"seo":{"title":"Retrieve fax jobs from a topic and confirm the receipt.","description":"This endpoint is used for two types of processes:"}},"httpPath":"/topics/{topic}"},{"label":"Download file by  file name (Id.Extension)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax2ws-pull-api/fax2wspull-client/pollfaxdocuments","routeSlug":"/fax/fax2ws-pull-api/fax2wspull-client/pollfaxdocuments","metadata":{"seo":{"title":"Download file by  file name (Id.Extension)","description":"Download file by file name (Id.Extension)"}},"httpPath":"/files/{id}.{extension}"}]},{"type":"separator","label":"Fax Configuration API"},{"type":"link","label":"Fax Configuration API","link":"/fax/fax-config-api","routeSlug":"/fax/fax-config-api"},{"type":"group","label":"Inbound Fax","link":"/fax/fax-config-api/inbound-fax","routeSlug":"/fax/fax-config-api/inbound-fax","items":[{"label":"Retrieve inbound number configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/inbound-fax/getnumbers","routeSlug":"/fax/fax-config-api/inbound-fax/getnumbers","metadata":{"seo":{"title":"Retrieve inbound number configurations","description":"Retrieve inbound number configurations."}},"httpPath":"/inbound/numbers"},{"label":"Retrieve a single inbound fax number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/inbound-fax/getnumber","routeSlug":"/fax/fax-config-api/inbound-fax/getnumber","metadata":{"seo":{"title":"Retrieve a single inbound fax number","description":"Retrieve the configuration for the single specified inbound fax number."}},"httpPath":"/inbound/numbers/{number}"},{"label":"Update a single inbound fax number","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/inbound-fax/updatenumber","routeSlug":"/fax/fax-config-api/inbound-fax/updatenumber","metadata":{"seo":{"title":"Update a single inbound fax number","description":"Update a single inbound fax number. Any omitted fields are automatically defaulted to null, where null is equivalent to Default ie the value will be inherited from the assigned profile."}},"httpPath":"/inbound/numbers/{number}"}]},{"type":"group","label":"Inbound Fax Profiles","link":"/fax/fax-config-api/inbound-fax-profiles","routeSlug":"/fax/fax-config-api/inbound-fax-profiles","items":[{"label":"Retrieve inbound profile configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/inbound-fax-profiles/getinboundprofiles","routeSlug":"/fax/fax-config-api/inbound-fax-profiles/getinboundprofiles","metadata":{"seo":{"title":"Retrieve inbound profile configurations","description":"Retrieve inbound fax profile configurations."}},"httpPath":"/inbound/profiles"},{"label":"Retrieve a single inbound fax profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/inbound-fax-profiles/getinboundprofile","routeSlug":"/fax/fax-config-api/inbound-fax-profiles/getinboundprofile","metadata":{"seo":{"title":"Retrieve a single inbound fax profile","description":"Retrieve a specific inbound fax profile."}},"httpPath":"/inbound/profiles/{profile}"},{"label":"Create an inbound fax profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/inbound-fax-profiles/upsertinboundprofile","routeSlug":"/fax/fax-config-api/inbound-fax-profiles/upsertinboundprofile","metadata":{"seo":{"title":"Create an inbound fax profile","description":"Create an inbound fax profile."}},"httpPath":"/inbound/profiles/{profile}"},{"label":"Delete an inbound fax profile","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/inbound-fax-profiles/deleteinboundprofile","routeSlug":"/fax/fax-config-api/inbound-fax-profiles/deleteinboundprofile","metadata":{"seo":{"title":"Delete an inbound fax profile","description":"Delete an inbound fax profile."}},"httpPath":"/inbound/profiles/{profile}"}]},{"type":"group","label":"Mail to Fax","link":"/fax/fax-config-api/mail-to-fax","routeSlug":"/fax/fax-config-api/mail-to-fax","items":[{"label":"Retrieve a Mail2Fax user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax/getuser","routeSlug":"/fax/fax-config-api/mail-to-fax/getuser","metadata":{"seo":{"title":"Retrieve a Mail2Fax user","description":"Retrieve a Mail2Fax user"}},"httpPath":"/outbound/users/{user}"},{"label":"Upsert a Mail2Fax user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax/upsertuser","routeSlug":"/fax/fax-config-api/mail-to-fax/upsertuser","metadata":{"seo":{"title":"Upsert a Mail2Fax user","description":"Create a new or update an existing Mail2Fax user"}},"httpPath":"/outbound/users/{user}"},{"label":"Delete a Mail2Fax user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax/deleteuser","routeSlug":"/fax/fax-config-api/mail-to-fax/deleteuser","metadata":{"seo":{"title":"Delete a Mail2Fax user","description":"Delete a Mail2Fax user"}},"httpPath":"/outbound/users/{user}"},{"label":"Patch a Mail2Fax user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax/patchuser","routeSlug":"/fax/fax-config-api/mail-to-fax/patchuser","metadata":{"seo":{"title":"Patch a Mail2Fax user","description":"Patch (update) a Mail2Fax user"}},"httpPath":"/outbound/users/{user}"},{"label":"Retrieve Mail2Fax users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax/getusers","routeSlug":"/fax/fax-config-api/mail-to-fax/getusers","metadata":{"seo":{"title":"Retrieve Mail2Fax users","description":"Retrieve Mail2Fax users"}},"httpPath":"/outbound/users"}]},{"type":"group","label":"Mail to Fax Profiles","link":"/fax/fax-config-api/mail-to-fax-profiles","routeSlug":"/fax/fax-config-api/mail-to-fax-profiles","items":[{"label":"Retrieve Mail2Fax profiles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax-profiles/getmail2faxprofiles","routeSlug":"/fax/fax-config-api/mail-to-fax-profiles/getmail2faxprofiles","metadata":{"seo":{"title":"Retrieve Mail2Fax profiles","description":"Retrieve Mail2Fax profiles."}},"httpPath":"/outbound/profiles"},{"label":"Retrieve a Mail2Fax profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax-profiles/getmail2faxprofile","routeSlug":"/fax/fax-config-api/mail-to-fax-profiles/getmail2faxprofile","metadata":{"seo":{"title":"Retrieve a Mail2Fax profile","description":"Retrieve a specifc Mail2Fax profile"}},"httpPath":"/outbound/profiles/{profile}"},{"label":"Insert or update a Mail2Fax profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax-profiles/upsertmail2faxprofile","routeSlug":"/fax/fax-config-api/mail-to-fax-profiles/upsertmail2faxprofile","metadata":{"seo":{"title":"Insert or update a Mail2Fax profile","description":"Create a new or update an existing Mail2Fax profile"}},"httpPath":"/outbound/profiles/{profile}"},{"label":"Delete a Mail2Fax profile","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax-profiles/deletemail2faxprofile","routeSlug":"/fax/fax-config-api/mail-to-fax-profiles/deletemail2faxprofile","metadata":{"seo":{"title":"Delete a Mail2Fax profile","description":"Delete the specified Mail2Fax profile"}},"httpPath":"/outbound/profiles/{profile}"},{"label":"Patch a single outbound fax profile","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax-profiles/patchmail2faxprofile","routeSlug":"/fax/fax-config-api/mail-to-fax-profiles/patchmail2faxprofile","metadata":{"seo":{"title":"Patch a single outbound fax profile","description":"Patch a single outbound fax profile. #FIXME this description"}},"httpPath":"/outbound/profiles/{profile}"}]},{"type":"group","label":"Joint Outbound and Inbound","link":"/fax/fax-config-api/joint-outbound-and-inbound","routeSlug":"/fax/fax-config-api/joint-outbound-and-inbound","items":[{"label":"Retrieve joint fax accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/joint-outbound-and-inbound/getaccounts","routeSlug":"/fax/fax-config-api/joint-outbound-and-inbound/getaccounts","metadata":{"seo":{"title":"Retrieve joint fax accounts","description":"Retrieve joint fax accounts"}},"httpPath":"/joint/accounts/{correlation-id}"}]},{"type":"separator","label":"Fax Reporting API"},{"type":"link","fsPath":"fax/reporting-api.md","metadata":{"type":"markdown"},"label":"Fax Reporting API","link":"/fax/reporting-api","routeSlug":"/fax/reporting-api"}]}