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 

API Introduction

6min

This is our API Reference, dedicated to how to use the TIDY API. For general documentation, including introductions to many of the concepts listed here: Go To The TIDY Docs.

What is the TIDY API?

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

  • Requesting Jobs
  • Adding Pros you manage
  • Viewing Job Statuses
  • Updating the To-Do list for a job
  • Manage Guest Reservations for your Addresses

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.

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.

Basic Architecture

These are the core elements of the TIDY architecture.

  • Customers are accounts, with unique API Keys. They can have many Addresses.
  • Addresses are the physical locations for requested service. They can have many Jobs, Pros, or To-Do Lists.
  • Jobs are requested jobs for an Address. There can be many per address. Jobs can have Pros (who does the job) or To-Do Lists (what to do on the job).

Get Started

Most people get started with the following steps:

  1. Create API keys and set up Authentication
  2. Use endpoints to create jobs
  3. Set up webhooks to get job statuses



Updated 29 May 2023
Did this page help you?
Yes
No
PREVIOUS
Developers
NEXT
Authentication
Docs powered by archbee 
TABLE OF CONTENTS
What is the TIDY API?
Developer / API Support
Basic Architecture
Get Started