Developer Overview

Welcome to TIDY's developer documentation! TIDY provides powerful APIs and webhooks to integrate property cleaning and maintenance management into your applications.

Most developers who want to use TIDY within their own applications or extend TIDY's functionality do so in one of 2 ways:

  • Using the TIDY API - A REST API that gives you the ability to programmatically do things instead of via the website.
  • Using Webhooks - A way to get updates from TIDY to your application.

Quick Links

The TIDY API

The TIDY API lets you do many things you can do via the tidy.com website, including:

  • Requesting Bookings
  • Adding Pros you manage
  • Viewing Booking Statuses
  • Updating the To-Do list for a booking
  • Managing properties and addresses
  • Accessing job history and reports
## Example Use Case You have an internal application that tracks guest reservations for rental properties. You can use the TIDY API to automatically request a turnover cleaning after a guest checks out.

The TIDY API is a REST API that uses standard HTTP response codes, authentication, and verbs. In principle, any feature available online could be made available through the TIDY API.

API Resources

The API provides access to the following resources:

  • Addresses - Manage property addresses
  • Jobs - Create, view, and manage cleaning/maintenance jobs
  • Pros - Manage service professionals
  • To-Do Lists - Create and manage property-specific task lists
  • Webhooks - Set up event notifications

For full details, see our API Reference Documentation.

Webhooks

TIDY uses webhooks to send events to your application. For example, if you want to know when a booking is completed, you can add a webhook to TIDY so we send that notification to your application.

View More About Webhooks →

Developer / API Support

We offer free API support for developers. To get that, you must:

  • Have an account (it's free)
  • Make sure you have "developer options" enabled (tap the developer tab to enable this)
  • Make requests from the "Developers" section or "Concierge" section

Our goal is to make your lives easier, but by logging in it helps us ensure security & privacy.

Getting Started

  1. Create an Account - Sign up for a free TIDY account
  2. Enable Developer Options - Access the developer section in your account
  3. Get API Keys - Generate your API authentication credentials
  4. Read the Docs - Review our API Introduction and Authentication guides
  5. Test Your Integration - Use our sandbox environment to test
  6. Go Live - Deploy your integration to production

Questions? Contact us at sales@tidy.com or visit our Developer Portal for more resources.