# Integrations - [API Docs](https://docs.keyfax.biz/integrations/apis.md): Available API's for developers integrating Keyfax into host systems. - [REST API](https://docs.keyfax.biz/integrations/apis/rest-api.md): Documentation for versions of the Keyfax REST based Web API. - [Quick Start](https://docs.keyfax.biz/integrations/apis/rest-api/quick-start.md): Learn how to quickly get started with the Keyfax REST based Web API. - [Deep Dive](https://docs.keyfax.biz/integrations/apis/rest-api/deep-dive.md): A technical deeper dive into the Keyfax REST based Web API. - [API SDKs](https://docs.keyfax.biz/integrations/apis/rest-api/api-sdks.md): Learn how to use the Keyfax Web API .NET or JavaScript SDK's. - [.NET SDK](https://docs.keyfax.biz/integrations/apis/rest-api/api-sdks/.net-sdk.md): Learn more about the Keyfax Web API .NET SDK. - [JavaScript SDK](https://docs.keyfax.biz/integrations/apis/rest-api/api-sdks/javascript-sdk.md): Learn how to use the Keyfax Web API JavaScript SDK. - [Start-Up Data](https://docs.keyfax.biz/integrations/apis/rest-api/api-sdks/start-up-data.md) - [Processing Results](https://docs.keyfax.biz/integrations/apis/rest-api/api-sdks/processing-results.md) - [API Reference](https://docs.keyfax.biz/integrations/apis/rest-api/api-reference.md): The main Web API end points required for most host integrations. - [SOAP API](https://docs.keyfax.biz/integrations/apis/soap.md): Technical details related to the Keyfax SOAP based web services. - [Quick Start](https://docs.keyfax.biz/integrations/apis/soap/quick-start.md): A guide to help you get up & running with the Keyfax SOAP API. - [Error Handling](https://docs.keyfax.biz/integrations/apis/soap/error-handling.md): Error handling details related to the Keyfax SOAP based web services. - [Status Codes](https://docs.keyfax.biz/integrations/apis/soap/status-codes.md): Status Codes returned by Keyfax upon script completion. - [XML Schemas](https://docs.keyfax.biz/integrations/apis/soap/xml-schemas.md) - [Startup Schema](https://docs.keyfax.biz/integrations/apis/soap/xml-schemas/startup-schema.md): All the supported start-up data supported by Keyfax. - [Results Schema](https://docs.keyfax.biz/integrations/apis/soap/xml-schemas/results-schema.md): Details the export information generated by a Keyfax session. - [Results with Note](https://docs.keyfax.biz/integrations/apis/soap/xml-schemas/results-with-note.md): This sample illustrates an export schema with notes. - [Cancelled Schema](https://docs.keyfax.biz/integrations/apis/soap/xml-schemas/cancelled-schema.md): The default cancellation schema for a Keyfax session. - [Address data](https://docs.keyfax.biz/integrations/apis/soap/xml-schemas/address-data.md): How addresses are represented within Keyfax. - [Legacy APIs](https://docs.keyfax.biz/integrations/apis/legacy-apis.md) - [Active X](https://docs.keyfax.biz/integrations/apis/legacy-apis/active-x.md) - [Asynchronous Pluggable Protocols](https://docs.keyfax.biz/integrations/apis/legacy-apis/asynchronous-pluggable-protocols.md) - [XmlHttp](https://docs.keyfax.biz/integrations/apis/legacy-apis/xmlhttp.md) - [Integrations](https://docs.keyfax.biz/integrations/host-systems.md): Keyfax can integrate with the following housing management systems and tenant portals. - [Aareon](https://docs.keyfax.biz/integrations/host-systems/aareon.md): Information on how to integrate Keyfax with Aareon QL. - [Introduction](https://docs.keyfax.biz/integrations/host-systems/aareon/introduction.md): Learn more about the Keyfax integration with Aareon QL. - [Launching Keyfax Repairs](https://docs.keyfax.biz/integrations/host-systems/aareon/launching-keyfax-repairs.md): Launching Keyfax Repairs via Aareon QL. - [Launching Keyfax Enquiries](https://docs.keyfax.biz/integrations/host-systems/aareon/launching-keyfax-enquiries.md): Launching Keyfax Enquiries via Aareon QL. - [Configuration](https://docs.keyfax.biz/integrations/host-systems/aareon/configuration.md): Important configuration settings for Aareon QL. - [SOAP based integration](https://docs.keyfax.biz/integrations/host-systems/aareon/soap-based-integration.md) - [QL Message fields](https://docs.keyfax.biz/integrations/host-systems/aareon/ql-message-fields.md): Learn how to populate QL message fields. - [Known problems](https://docs.keyfax.biz/integrations/host-systems/aareon/known-problems.md) - [Accuserve](https://docs.keyfax.biz/integrations/host-systems/internetalia-accuserve.md): Information on how to integrate Keyfax with Accuserve. - [ActiveH Desktop](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop.md): Information on how to integrate Keyfax with ActiveH Desktop. - [Introduction](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/introduction.md): Shows how to launch Keyfax from MIS ActiveH. - [ActiveH Repair Interface](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/activeh-repair-interface.md): The standard repairs interface from Keyfax to ActiveH - [Known Problems](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/known-problems.md): Know issues related to ActiveH Desktop and the Keyfax Client. - [Keyfax Configuration](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/keyfax-configuration.md): Configuring Keyfax for use with MIS-AMS SQL ActiveH applications. - [MISExchange.xml](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/keyfax-configuration/misexchange.xml.md): Keyfax mapping configuration file (MISExchange.xml) - [Example Settings](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/keyfax-configuration/example-settings.md): Example Keyfax configuration settings for use with ActiveH Desktop. - [Retrieving Block Codes](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/keyfax-configuration/retrieving-block-codes.md): Learn how to retrieve block codes when working with ActiveH Desktop. - [MIS Configuration](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-configuration.md): Configuring the MIS-AMS SQL ActiveH applications to use Keyfax. - [Exchange Process](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-configuration/exchange-process.md): Keyfax exchange process with ActiveH CRM & Repairs - [Exchange Elements](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-configuration/exchange-elements.md) - [User Permissions](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-configuration/user-permissions.md): Configure User Permissions to work with User Defined Entries (UDE's) - [User Security](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-configuration/user-security.md): User security settings within MIS ActiveH Desktop. - [UDE Interface](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-configuration/ude-interface.md): Configuration of the Task UDE Interface within MIS ActiveH Repairs - [UDE Configuration](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-configuration/ude-configuration.md): Configuration of Keyfax UDE within the MIS-AMS SQL ActiveH Desktop. - [Settings](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-configuration/settings.md) - [Desktop Configuration](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-configuration/desktop-configuration.md): Configuration of Keyfax within the MIS ActiveH Desktop - [Priorities Configuration](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-configuration/priorities-configuration.md): Configuration of Priority codes within the MIS-AMS SQL ActiveH Desktop. - [Populating Job Type](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-configuration/populating-job-type.md): Populating the 'Job Type' field for ActiveH Repairs - [Populating Assigned To](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-configuration/populating-assigned-to.md) - [Populating Call Classification](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-configuration/populating-call-classification.md): Populating Call Classification and Priority for User Level Tasks - [Configuring Log Call](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-configuration/configuring-log-call.md): The changes to log the Keyfax call within ActiveH Desktop. - [Launching Keyfax from Response Repairs](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-configuration/configuring-log-call/launching-keyfax-from-response-repairs.md) - [Workflow Integration Actions](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-configuration/workflow-integration-actions.md) - [MIS interface Objects](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-interface-objects.md): Interface objects compatible with ActiveH Desktop. - [CRM Gateway](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-interface-objects/crm-gateway.md): A list of known ActiveH CRM Gateway Objects. - [Desktop Task](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-interface-objects/desktop-task.md): A list of known desktop task objects. - [System Task Email Addressee](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-interface-objects/system-task-email-addressee.md): A list of known system task email addressee objects. - [Desktop Task Action](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-interface-objects/desktop-task-action.md): Desktop Task Action Object (not currently used by Keyfax) - [Repair Request](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-interface-objects/repair-request.md): Repair Request Object (from Repairs & CRM) - [Repair Request Inspection](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-interface-objects/repair-request-inspection.md): Repair Request Inspection Object (from repairs & CRM) - [Repair Request Task](https://docs.keyfax.biz/integrations/host-systems/activeh-desktop/mis-interface-objects/repair-request-task.md): Repair Request Task Object (from repairs & CRM) - [ActiveH Portal (TIPS)](https://docs.keyfax.biz/integrations/host-systems/activeh-portal-tips.md): Information on how to integrate Keyfax with ActiveH Customer Portal / TIPS. - [Introduction](https://docs.keyfax.biz/integrations/host-systems/activeh-portal-tips/introduction.md): Details related to the Keyfax & ActiveH Customer Portal integration. - [Settings](https://docs.keyfax.biz/integrations/host-systems/activeh-portal-tips/settings.md): ActiveH Customer Portal Integration Settings. - [Known Issues](https://docs.keyfax.biz/integrations/host-systems/activeh-portal-tips/known-issues.md): Potential issues with the Keyfax & MIS Customer Portal integration. - [ActiveH Web](https://docs.keyfax.biz/integrations/host-systems/activeh-customer-portal.md): Information on how to integrate Keyfax with ActiveH Web. - [Breeze IT](https://docs.keyfax.biz/integrations/host-systems/breeze.md): Information on how to integrate Keyfax with Breeze IT. - [Caltech](https://docs.keyfax.biz/integrations/host-systems/caltech.md): Information on how to integrate Keyfax with CalTech - [Capita](https://docs.keyfax.biz/integrations/host-systems/capita.md): Information on how to integrate Keyfax with Capita. - [Capita Housing / Academy](https://docs.keyfax.biz/integrations/host-systems/capita/capita-housing-academy.md): Integration of Keyfax with Academy Housing (v3-7). - [Host Table Usage](https://docs.keyfax.biz/integrations/host-systems/capita/capita-housing-academy/host-table-usage.md) - [Troubleshooting](https://docs.keyfax.biz/integrations/host-systems/capita/capita-housing-academy/troubleshooting.md) - [Open Housing](https://docs.keyfax.biz/integrations/host-systems/capita/open-housing.md): Open Housing is Capita's flagship Housing Management System. - [Civica](https://docs.keyfax.biz/integrations/host-systems/civica.md): Information on how to integrate Keyfax with Civica. - [Civica CX](https://docs.keyfax.biz/integrations/host-systems/civica/civica-cx.md): Create repair requests, works orders, tasks & inspections from Keyfax within Civica CX - [Introduction](https://docs.keyfax.biz/integrations/host-systems/civica/civica-cx/introduction.md): Learn how the Keyfax & Civica CX integration works. - [Mappings](https://docs.keyfax.biz/integrations/host-systems/civica/civica-cx/mappings.md) - [Start Up Data](https://docs.keyfax.biz/integrations/host-systems/civica/civica-cx/start-up-data.md): Learn more about the start-up data sent to Keyfax from Civica CX. - [Inspections](https://docs.keyfax.biz/integrations/host-systems/civica/civica-cx/inspections.md) - [Known Issues](https://docs.keyfax.biz/integrations/host-systems/civica/civica-cx/known-issues.md): Common Civica CX issues and known solutions. - [Civica CM](https://docs.keyfax.biz/integrations/host-systems/civica/civica-cm.md): Integration with Civica Contact Manager - [Known problems](https://docs.keyfax.biz/integrations/host-systems/civica/civica-cm/known-problems.md): Known issues with the Keyfax + Civica CM integration. - [Servitor](https://docs.keyfax.biz/integrations/host-systems/civica/servitor.md): Keyfax integration with Civica Servitor. - [Example Import XML](https://docs.keyfax.biz/integrations/host-systems/civica/servitor/example-import-xml.md): Sample start-up data to use with Civica Servitor . - [Example Export XML](https://docs.keyfax.biz/integrations/host-systems/civica/servitor/example-export-xml.md): Example Keyfax results for Civica Servitor integrations. - [ContactView](https://docs.keyfax.biz/integrations/host-systems/contactview.md): Information on how to integrate Keyfax with Keyfax Contact•View. - [Dynamics](https://docs.keyfax.biz/integrations/host-systems/keynamics.md): Keyfax plus the power of Dynamics & the Power Apps Platform - [KeyNect](https://docs.keyfax.biz/integrations/host-systems/keynect.md) - [Kirona](https://docs.keyfax.biz/integrations/host-systems/kirona.md): Information on how to integrate Keyfax with Kirona. - [Lagan](https://docs.keyfax.biz/integrations/host-systems/lagan.md): Information on how to integrate Keyfax with Lagan. - [MIS](https://docs.keyfax.biz/integrations/host-systems/mis-active-management-systems.md): Information on how to integrate Keyfax with MIS. - [MRI](https://docs.keyfax.biz/integrations/host-systems/orchard-housing.md): Information on how to integrate Keyfax with MRI (formerly Orchard) - [Northgate](https://docs.keyfax.biz/integrations/host-systems/northgate.md): Information on how to integrate Keyfax with Breeze - [Launching Keyfax](https://docs.keyfax.biz/integrations/host-systems/northgate/launching-keyfax.md): Launching Keyfax from Northgate Housing. - [Exchange process](https://docs.keyfax.biz/integrations/host-systems/northgate/exchange-process.md): Keyfax exchange process with Northgate Sx3 Housing. - [XML/Field mappings](https://docs.keyfax.biz/integrations/host-systems/northgate/xml-field-mappings.md): Keyfax XML data mappings to Sx3 Housing Fields - [OneServe](https://docs.keyfax.biz/integrations/host-systems/oneserve.md): Information on how to integrate Keyfax with OneServe. - [ROCC](https://docs.keyfax.biz/integrations/host-systems/rocc.md): Information on how to integrate Keyfax with ROCC. - [Total Mobile](https://docs.keyfax.biz/integrations/host-systems/total-mobile.md): Information on how to integrate Keyfax with Total Mobile. - [Launching Keyfax (TASK)](https://docs.keyfax.biz/integrations/host-systems/total-mobile/launching-keyfax-task.md): Launching Keyfax via the Total Mobile Job Wizard. - [TotalView Configuration](https://docs.keyfax.biz/integrations/host-systems/total-mobile/totalview-configuration.md): The Keyfax & TotalView standard configuration. - [SDM](https://docs.keyfax.biz/integrations/host-systems/sdm.md): Information on how to integrate Keyfax with SDM - [Salesforce](https://docs.keyfax.biz/integrations/host-systems/salesforce.md): Information on how to integrate Keyfax with Salesforce - [Best Practices](https://docs.keyfax.biz/integrations/project-considerations.md): Recommendations when undertaking a Keyfax integration - [Integration Considerations](https://docs.keyfax.biz/integrations/project-considerations/integration-considerations.md): Considerations when undertaking a Keyfax integration - [Displaying Keyfax Self-Service](https://docs.keyfax.biz/integrations/project-considerations/displaying-keyfax-self-service.md): Our recommendations for displaying Keyfax Self-Service. - [Handling Priorities](https://docs.keyfax.biz/integrations/project-considerations/handling-priorities.md): Learn how to handle priorities returned by Keyfax - [Handling Files](https://docs.keyfax.biz/integrations/project-considerations/handling-files.md): How integrators should handle files returned by Keyfax. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.keyfax.biz/integrations.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.