SwiftFox API Documentation

The Red Fox Group (the Organisation) is committed to protecting the privacy of all client data it is provided with to carry out the services for which it is engaged to perform.

The Organisation’s policies are designed to comply with all state and national legislation, in particular the Australian Privacy Principles (APP).

The Organisation commits to:

  • only collecting data from clients and individuals in accordance with the APPs;
  • being fair and open in the way it collects the data, and only collect data actually required in the course of providing its clients with services;
  • retaining clients’ data in a secure environment;
  • only providing essential information to its agents or service providers for the purpose of conducting client business;
  • binding all staff, agents and service providers to its confidentiality agreements and its Privacy Policies;
  • not sharing or selling client data to any third party for marketing purposes and not releasing information unless required by law to do so;
  • allowing clients access to their client data held and inviting clients to advise the Organisation if any information is incomplete, inaccurate or out-of-date;
  • where possible, amending any data that clients may consider incomplete, inaccurate or out-of-date;
  • providing clients with a copy of its Privacy Policy if required;
  • explaining the reasons for collecting data, how it is used and the consequences of not having the data required.

Authentication

To access the SwiftFox API, you will need an API key.

Header - Authorization

Value - Bearer <api key>

Required - Yes

For help finding your API key, please contact support@swiftfoxcrm.com

‍

Capabilities

The SwiftFox API has a number of GET, POST and PUT commandsto retrieve, search, create and update data within your SwiftFox.

‍

Swagger

The SwiftFox API has a Swagger page to explain all currentendpoints and capabilities. This page will automatically update as endpointsare updated or expanded.

https://api.ci.swiftfoxcrm.com/swagger/index.html

‍

Third-Party Integrations

SwiftFox currently has an integration with Zapier which canallow clients to access the benefits of the API, alongside many of theirexisting apps and services on the Zapier marketplace.

You can find SwiftFox within the Zapier marketplace.

 

SwiftFox API Accetable Use Policy

This Acceptable Use Policy ("Policy") governs theacceptable use of the SwiftFox CRM API ("API") provided by SwiftFoxCRM. By accessing or using the API, you agree to comply with this Policy.

‍

Purpose of the API:

The API is intended to facilitate integration with SwiftFoxCRM, allowing authorised users to access and interact with the CRM systemprogrammatically, retrieve data, and perform approved actions.

Prohibited Activities:

Users of the API shall not engage in the following activities:

a.    Misuse or Unauthorised Access: Attempting togain unauthorised access to the SwiftFox CRM system, circumventingauthentication mechanisms, or tampering with the API endpoints or data.

b.   Data Breach or Privacy Violation: Collecting, storing,or transmitting any personal or sensitive data obtained through the API withoutproper consent or in violation of applicable data protection regulations.

c.    Spamming and Malicious Activities: Sendingunsolicited communications, including spam or phishing attempts, or engaging inany activity that may harm or disrupt the SwiftFox CRM system or its users.

d.   Intellectual Property Infringement: Violatingintellectual property rights, including but not limited to unauthorised use,reproduction, or distribution of copyrighted material or trademarks.

e.    System Abuse: Engaging in activities that couldoverload, degrade, or interfere with the performance or stability of theSwiftFox CRM system or any related infrastructure.

f.     Illegal or Harmful Activities: Engaging in anyactivity that is illegal, promotes illegal actions, or causes harm toindividuals, organisations, or public welfare.

‍

Data Usage and Privacy:

Users of the API shall handle data obtained through the APIin accordance with applicable laws and regulations. This includes obtainingnecessary consents, handling data securely, and deleting data when it is nolonger required for the intended purpose.

Rate Limiting and Usage Quotas:

Users shall adhere to any rate limits or usage quotasimposed by SwiftFox CRM to prevent excessive usage that may negatively impactsystem performance or availability.

Reporting Misuse:

Users shall promptly report any known or suspected misuse orabuse of the API to SwiftFox CRM by contacting support@swiftfoxcrm.com

Consequences of Violation:

Violation of this Policy may result in the temporary orpermanent suspension of API access, blocking of IP addresses, or any otherappropriate action deemed necessary by SwiftFox CRM. Severe violations may leadto legal consequences.

Updates to the Policy:

This Policy may be updated periodically at the discretion ofSwiftFox CRM. Users will be notified of any significant changes, and theupdated Policy will be effective as of the specified date.

 

‍