Warning: Only resources, actions, and attributes documented here should be considered public. Any undocumented resources, actions, or attributes should be considred private and may change at any time without notice. Be extra cautious of undocumented attributes since those are the most likely to change.

If you with to use a undocumented portion of the API, please contact us first so we can either a) document it and make it public or b) explain what planned changes are in store for that part of the API.

Introduction

QuickLease Pro’s newer user interface uses the API. So as a general rule, you can do anything that QuickLease Pro can do via the UI. These documents only document the most commonly used portions of the API. If you need something that isn’t documented here, please let us know.

Authentication

QuickLease Pro’s API uses HTTP Basic Authentication. Use the API Key we issue as the HTTP Basic Authentication username and leave the password blank.

Most HTTP client libraries should have HTTP Basic Authentication baked right in. You can learn more about HTTP Basic Authentication here: https://en.wikipedia.org/wiki/Basic_access_authentication.

Content-Type

The QuickLease Pro API ingests JSON and therefore expects the Content-Type header to be set to application/json.

Content-Type: application/json

Testing

Currently QuickLease Pro does not have development environment that is available to integrators. Instead, we recommend setting up a test client in the production environment.