> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Tidy

> TIDY helps to maintain a clean house. A rental. Your employee's workspace. Your home. All automated through TIDY.

![Tidy logo](https://mintcdn.com/composio-preview/IA0_SoMcsWt17HEC/images/toolkits/tidy.svg?fit=max\&auto=format\&n=IA0_SoMcsWt17HEC\&q=85\&s=db2c6b4afa0f1749b0c713cceaf70234)

* **Category:** scheduling & booking
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 10
* **Triggers:** 0
* **Slug:** `TIDY`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Address
>
> **Slug:** `TIDY_CREATE_ADDRESS`
>
> Tool to create a new address record with location data, parking information, and access instructions. Use when you need to add a new property address to Tidy.
>
> #### Input Parameters
>
> **city** `string`
>
> City name.
>
> **unit** `string`
>
> Apartment or unit number.
>
> **notes** `object`
>
> Notes about property access and closing procedures.
>
> **address** `string` *required*
>
> Street name and number (e.g., '123 Main St').
>
> **country** `string` *required*
>
> Country code (e.g., 'US').
>
> **parking** `object` *required*
>
> Parking information object containing parking details.
>
> **postal\_code** `string` *required*
>
> Postal/ZIP code (e.g., '92626').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Pro
>
> **Slug:** `TIDY_CREATE_PRO`
>
> Tool to add a Pro to the Priority List for all addresses in a customer account. Use when syncing professional service provider information from another application into TIDY.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Full name of the Pro to add to the Priority List.
>
> **email** `string` *required*
>
> Email address of the Pro. Must be a valid email format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Address
>
> **Slug:** `TIDY_DELETE_ADDRESS`
>
> Tool to remove an address from the system by its unique identifier. Use when you need to delete an address that has no active scheduled jobs. Important: Addresses with active jobs cannot be deleted and must have their jobs cancelled first.
>
> #### Input Parameters
>
> **address\_id** `string` *required*
>
> The unique identifier of the address to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List All Addresses
>
> **Slug:** `TIDY_LIST_ALL_ADDRESSES`
>
> Tool to retrieve all addresses sorted by creation date with most recent first. Use when you need to view all property addresses in the Tidy system.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List All Jobs
>
> **Slug:** `TIDY_LIST_ALL_JOBS`
>
> List account jobs with optional filters for address, status, or to-do list. Results can be requested by page and page size.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination (starts at 1). Use to retrieve subsequent pages of results.
>
> **status** `string`
>
> Filter jobs by status. Supports single or comma-separated multiple values. Accepted values: 'scheduled', 'in\_progress', 'completed', 'cancelled', 'failed'.
>
> **per\_page** `integer`
>
> Number of jobs to return per page (max 100). Controls the page size of results.
>
> **address\_id** `string`
>
> Filter jobs by address identifier. Supports single value (e.g., '1') or comma-separated multiple values (e.g., '1,2').
>
> **to\_do\_list\_id** `string`
>
> Filter jobs by to-do list identifier. Supports single value (e.g., '1') or comma-separated multiple values (e.g., '1,2').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Available Booking Time Slots
>
> **Slug:** `TIDY_LIST_AVAILABLE_BOOKING_TIME_SLOTS`
>
> Tool to retrieve available booking time slots from professionals in your network for the next 4 weeks. Use when you need to find instantly available times to book a service.
>
> #### Input Parameters
>
> **address\_id** `integer` *required*
>
> The identifier of the address to check availability for.
>
> **service\_type\_key** `string` *required*
>
> The service type key to filter availability (e.g., 'regular\_cleaning.one\_hour').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Guest Reservations
>
> **Slug:** `TIDY_LIST_GUEST_RESERVATIONS`
>
> Tool to retrieve all guest reservations sorted by creation date with most recent first. Use when you need to view or manage guest bookings in the Tidy system.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List To-Do Lists
>
> **Slug:** `TIDY_LIST_TO_DO_LISTS`
>
> Tool to retrieve all active address to-do lists with optional filtering by address\_id, sorted by creation date with most recent first. Use when you need to view or manage to-do lists in the Tidy system.
>
> #### Input Parameters
>
> **address\_id** `string`
>
> Filter to-do lists by address identifier. Supports single value (e.g., '1') or comma-separated multiple values (e.g., '1,2').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Address
>
> **Slug:** `TIDY_RETRIEVE_ADDRESS`
>
> Tool to retrieve the details of an existing address by its unique identifier. Use when you need to view complete information about a specific address including parking and access notes.
>
> #### Input Parameters
>
> **address\_id** `string` *required*
>
> The unique identifier of the address to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Address
>
> **Slug:** `TIDY_UPDATE_ADDRESS`
>
> Tool to update parking details and access notes for an existing address. Use when you need to modify parking information or property access instructions. Important: Cannot update address, unit, postal\_code, or country\_code - these fields require creating a new address.
>
> #### Input Parameters
>
> **notes** `object`
>
> Notes about property access and closing procedures for updating an address.
>
> **parking** `object`
>
> Parking information for updating an address.
>
> **address\_id** `string` *required*
>
> The unique identifier of the address to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
