website logo
⌘K
Getting Started
What is TIDY?
Getting Started: Rental Properties
Getting Started: Employer Benefits
Getting Started: Residential Homes
Getting Started: Offices
Dashboard
TIDY AI
Acceptance Probability
Teams & Users
Users
Teams
Properties/Addresses
Access Instructions
Jobs
Add or Request a Job
View, Edit, or Cancel Jobs
Setting Backup Times
Job Links
Job Reviews or Feedback
Resolving Pro Cancellations
Account Settings
Messages
Notifications
Plans
Access Control / Smartlocks
My Pros
Booking Different Type Of Services With Your Pros
Private Cleaning Payment
Defining your Job Request Strategy
To-Do Lists
Video Introductions
To-Do List Links
To-Dos
Do-Nots
Remote Inspections
Custom Fields
Laundry or Linens
Supply Preferences
Integrations
Automatic Booking
Billing, Pricing, & Payments
Billing History
Sending Payments
Bills & Payment Methods
Team Billing
View & Edit Prices
Viewing Billing History
Tips
Refunds
Rebate Program
Tax Reporting for Payments to Pros
Compliance, Ratings, Safety, Insurance, & Protection
Insurance or Custom Requirements
Certifications & Ratings
Satisfaction Guarantee, Disputes, & Protection
Damage Claims
Property Maps
Maintenance
Inventory Tracking
Inspections
Smart Thermostats
Issue Tracking
Automatic Translation
Other Questions
TIDY Concierge
Reports
Accounting
Developers
API Introduction
Authentication
Changelog
Errors
API Reference
Webhooks
Best Practices
Docs powered by archbee 

Developers

6min

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.



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

Example

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.



For details, View Our API Reference.



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 (its 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.

Updated 24 May 2023
Did this page help you?
Yes
No
PREVIOUS
Accounting
NEXT
API Introduction
Docs powered by archbee 
TABLE OF CONTENTS
The TIDY API
Example
Webhooks
Developer / API Support