# Tidy

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

- **Category:** scheduling & booking
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `TIDY`
- **Version:** 00000000_00

## Tools

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | City name. |
| `unit` | string | No | Apartment or unit number. |
| `notes` | object | No | Notes about property access and closing procedures. |
| `address` | string | Yes | Street name and number (e.g., '123 Main St'). |
| `country` | string | Yes | Country code (e.g., 'US'). |
| `parking` | object | Yes | Parking information object containing parking details. |
| `postal_code` | string | Yes | Postal/ZIP code (e.g., '92626'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Full name of the Pro to add to the Priority List. |
| `email` | string | Yes | Email address of the Pro. Must be a valid email format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address_id` | string | Yes | The unique identifier of the address to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List All Jobs

**Slug:** `TIDY_LIST_ALL_JOBS`

Tool to retrieve all jobs associated with an account with optional filtering by address_id, status, or to_do_list_id. Use when you need to view or manage jobs in the Tidy system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string | No | Filter jobs by status. Supports single or comma-separated multiple values. Accepted values: 'scheduled', 'in_progress', 'completed', 'cancelled', 'failed'. |
| `address_id` | string | No | 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 | No | Filter jobs by to-do list identifier. Supports single value (e.g., '1') or comma-separated multiple values (e.g., '1,2'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address_id` | integer | Yes | The identifier of the address to check availability for. |
| `service_type_key` | string | Yes | The service type key to filter availability (e.g., 'regular_cleaning.one_hour'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address_id` | string | No | Filter to-do lists by address identifier. Supports single value (e.g., '1') or comma-separated multiple values (e.g., '1,2'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address_id` | string | Yes | The unique identifier of the address to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notes` | object | No | Notes about property access and closing procedures for updating an address. |
| `parking` | object | No | Parking information for updating an address. |
| `address_id` | string | Yes | The unique identifier of the address to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |