Getting Started With the QQCatalyst API

The QQCatalyst API allows developers to build apps that integrate with QQCatalyst and securely access Catalyst data via our application services. If you would like to integrate with Catalyst, we have everything you need right here. To get started with Catalyst API integration, please contact our API team via email. We’ll then talk with you about becoming an API partner.

In order to interact with the Catalyst API, you will need to register with QQ Solutions as an API partner. After successfully registering, we will provide you with security tokens and credentials for use during authentication, as documented in the security section of this site. Subsequently, each of your insurance agency customers will need to work with you directly to allow your app to access to their individual Catalyst accounts.

Once you have registered as an API partner, you can download our sample application and view our detailed API documentation. We will also set you with a sandbox Catalyst account (for a nominal annual fee) and help you bring your product to life.

Release Updates and Additions

Version 3.10 Highlights

  • Throttling technologies have been added to the QQCatalyst API. After this release, if a third party partner attempts to make more than 60 calls in one minute to the same endpoint for the same QQID/Tenant the partner will receive a 401 - Unauthorized response with a message body of 'You have exceeded the maximum allowed attempts for this endpoint on the QQCatalyst API for this QQID/tenant. Maximum admitted 60 requests per Minute'
  • Contacts
  • Policies

Version 3.8 Highlights

Version 3.7 Highlights

  • The technology used to serve our Catalyst APIs has been upgraded from WCF to the Microsoft WebAPI architecture built of the MVC platform. This provides a more efficient and customizable system and combines the best of both architectures. All existing API methods have been configured to use new, easier to configure signatures that would allow future versions of the same method to exist while the old ones remain. Our goal was to maintain 100% backwards compatibility with the existing APIs and their respected URLs to minimize or eliminate impact to 3rd party consumers.
  • Use of the QQCatalyst API Test Harness tool has been deprecated.
    • Developers can log into their own test tenants using https://app.qqcatalyst.com/apideveloper and run API tests without having to know their bearer token, this functionality replaces the QQCatalyst API Test Harness.
    • New functionality has been added to allow developers to directly test API methods on http://api.qqcatalyst.com/Help. A "Test this API" button in the lower right hand corner of the screen of each API method, will allow developers to enter the requested parameters and send the request. An encrypted bearer token is required to test methods using this tool. Bearer token can be retrieved from https://app.qqcatalyst.com/apideveloper
  • Added / Modified API Methods
    • Customers GET
      Added a parameter to the method used to get Customer Details to indicate if the user wants all the details including tasks/notes/files/ACORDs
    • Contact Addresses GET
      Return a list of addresses for a contact.
    • Contact XDates GET
      Return a list of XDates for a contact.

Version 3.6 Highlights

  • Contacts - Employees
    • Employee Shifts
      Provide a way for getting and updating Employee Shifts, found in the employee's user preferences tab in QQCatalyst.
    • Employee Details
      Provide a way to get an employee's User Details

Updates beyond this point refer to the old API format. Refer to Technical Documentation for the new method format and layout.


Version 3.5 Highlights

Version 3.4 Highlights

  • Contacts.svc
    • ContactsByDateModifiedCreated/Paged GET
      Available query string parameters: startDate, endDate, pageNumber, pageSize
      Use this method to get a list of contacts that have been modified or created for a specific data range. This is an extension of a method that already exists but it contains additional parameters to include paging. If you are using the old method and are experiencing issues please adjust your system to use the new, paged result set. By default the results are paged at 100 records and the max requested page count is 500.
    • Contact/{entityID}/Tasks GET
      Available query string parameters: pageNumber, pageSize, orderBy, orderDirection
      Use this method to get a list of tasks associated to a contact. This is not the employee assigned to the contact.
    • Employee/{entityID}/Tasks GET
      Available query string parameters: pageNumber, pageSize, orderBy, orderDirection
      Use this method to get a list of tasks associated to an Employee.
    • Employees/MarkTaskComplete/{taskId} POST
      Use this method to update a task to completed status.
    • Employees/UpdateTaskProgress POST
      Use this method to update a task. TaskDTO properties ID, Complete (percentage), Status and ReminderDate(Optional) should be filled. Status= Not Started, Waiting, In Progress, Deferred, Completed
    • Contact/{contactID}/Notes GET
      Available query string parameters: pageNumber, pageSize, orderBy, orderDirection
      Use this method to get a list of notes associated to a contact
  • Policies.svc
    • PoliciesByDateModifiedCreated/Paged GET
      Available query string parameters: startDate, endDate, pageNumber, pageSize
      Get a list of modified policies given a date range with paging. This is an extension of a method that already exists but it contains additional parameters to include paging. If you are using the old method and are experiencing issues please adjust your system to use the new, paged result set. By default the results are paged at 100 records and the max requested page count is 500.
    • Policy/{policyId}/DownPayment GET
      Get the down payment information for a policy.
    • Details/{policyDetailID}/InlandMarine
      Various methods will be found here to read and manipulate the Policy Detail sections of a Commercial Inland Marine Policies. Some methods will be found without the {policyDetailID} parameter. See the policy.svc help page for more details. These methods also cover policies with the Equipment Floater and Contractor"s Equipment Floater lines of business.
    • Details/{policyDetailID}/PersonalInlandMarine
      Various methods will be found here to read and manipulate the Policy Detail sections of a Personal Inland Marine Policy. Some methods will be found without the {policyDetailID} parameter. See the policy.svc help page for more details.
  • Files.svc
    • Files/Contact/{contactid}/Policy/{policyid}/Paged GET
      Available query string parameters: downloadAs, pageNumber, pageSize
      Get a list of files associated to a Policy ID, alternatively you can request the byte[] of the file with "downloadAs"= None, Thumbnail, Original. This is an extension of a method that already exists but it contains additional parameters to include paging. If you are using the old method and are experiencing issues please adjust your system to use the new, paged result set.
    • Files/Contact/{contactid}/Paged GET
      Available query string parameters: downloadAs, pageNumber, pageSize
      Get a list of files associated to a Contact ID, alternatively you can request the byte[] of the file with "downloadAs"= None, Thumbnail, Original. This is an extension of a method that already exists but it contains additional parameters to include paging. If you are using the old method and are experiencing issues please adjust your system to use the new, paged result set.