Cleaning & Maintenance — TIDY

Schedule and manage cleaning jobs, create maintenance tasks, check booking availability, and add service professionals through the TIDY API. Built for property managers, Airbnb hosts, and cleaning service coordinators.

Authentication

All requests require a Bearer token.

CODEBLOCK0

Tokens do not expire. Include Authorization: Bearer $TIDY_API_TOKEN on all requests.

Jobs (Cleaning Bookings)

Jobs represent scheduled cleaning appointments.

Service Types

Booking Statuses

INLINECODE8 → in_progress → completed or cancelled or INLINECODE12

Check Availability

Before creating a booking, check available time slots:

CODEBLOCK1

Required: address_id, service_type_key.

List all jobs

CODEBLOCK2

Get a single job

CODEBLOCK3

Response fields: id, address_id, to_do_list_id, status, price, service_type_key, service_type_name, current_start_datetime (date, time), preferred_start_datetime (date, time), start_no_earlier_than (date, time), end_no_later_than (date, time), is_partially_completed, cancelled_by, url, created_at.

Create a job

CODEBLOCK4

Required: address_id, service_type_key, start_no_earlier_than (with date and time), end_no_later_than (with date and time).

Optional: preferred_start_datetime (with date, time), to_do_list_id.

The time window (start_no_earlier_than to end_no_later_than) defines when the service provider can arrive. preferred_start_datetime is a soft preference within that window.

Date format: YYYY-MM-DD. Time format: HH:MM (24-hour).

Update a job

CODEBLOCK5

Cancel a job

CODEBLOCK6

Reschedule a job

CODEBLOCK7

Required: service_type_key, start_no_earlier_than, end_no_later_than.

Optional: preferred_start_datetime, to_do_list_id.

Tasks (Maintenance / Issue Reports)

Tasks represent maintenance issues or repair requests tied to a property.

Task Statuses

INLINECODE60 → in_progress → INLINECODE62

Task Urgency Levels

INLINECODE63, normal, high, INLINECODE66

List tasks

CODEBLOCK8

Get a single task

CODEBLOCK9

Response fields: id, address_id, title, description, reporter_type, reporter_name, type, status, urgency, due_date, assigned_to_concierge, archived_at, created_at.

Create a task

CODEBLOCK10

Required: address_id, title, description, type.

Optional: status, urgency, due_date (YYYY-MM-DD), assigned_to_concierge (boolean — if true, TIDY will auto-handle).

Update a task

CODEBLOCK11

Delete a task

CODEBLOCK12

Service Professionals (Pros)

Add your own cleaning or maintenance professionals to the TIDY platform.

CODEBLOCK13

Required: name, email.

Optional: phone, service_types (array, default ["regular_cleaning"]).

To-Do Lists

To-do lists are cleaning checklists attached to jobs.

CODEBLOCK14

Natural Language (message-tidy)

For complex or multi-step operations, send a natural language request:

CODEBLOCK15

This is asynchronous. Poll GET /api/v2/message-tidy/{id} every 3–5 seconds until status is completed.

Example requests

• - "Schedule a 2.5 hour deep clean at address 123 for next Tuesday between 9am and 5pm"
• "Cancel booking 456"
• "Reschedule my cleaning to Friday"
• "Create a maintenance task: the dishwasher is leaking at my Beach House"
• "Show me all scheduled cleanings"
• "What time slots are available for a 4-hour cleaning at address 123?"

CLI Alternative

Install: brew install tidyapp/tap/tidy-request or npm i -g @tidydotcom/cli.

CODEBLOCK16

Error Handling