Skip to main content
Tidy logo
  • Category: scheduling & booking
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: TIDY
  • Version: 20261101_00

Tools

Slug: TIDY_CREATE_ADDRESSTool 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

string
City name.
string
Apartment or unit number.
object
Notes about property access and closing procedures.
string
required
Street name and number (e.g., ‘123 Main St’).
string
required
Country code (e.g., ‘US’).
object
required
Parking information object containing parking details.
string
required
Postal/ZIP code (e.g., ‘92626’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIDY_CREATE_PROTool 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

string
required
Full name of the Pro to add to the Priority List.
string
required
Email address of the Pro. Must be a valid email format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIDY_DELETE_ADDRESSTool 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

string
required
The unique identifier of the address to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIDY_LIST_ALL_ADDRESSESTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIDY_LIST_ALL_JOBSList account jobs with optional filters for address, status, or to-do list. Results can be requested by page and page size.

Input Parameters

integer
Page number for pagination (starts at 1). Use to retrieve subsequent pages of results.
string
Filter jobs by status. Supports single or comma-separated multiple values. Accepted values: ‘scheduled’, ‘in_progress’, ‘completed’, ‘cancelled’, ‘failed’.
integer
Number of jobs to return per page (max 100). Controls the page size of results.
string
Filter jobs by address identifier. Supports single value (e.g., ‘1’) or comma-separated multiple values (e.g., ‘1,2’).
string
Filter jobs by to-do list identifier. Supports single value (e.g., ‘1’) or comma-separated multiple values (e.g., ‘1,2’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIDY_LIST_AVAILABLE_BOOKING_TIME_SLOTSTool 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

integer
required
The identifier of the address to check availability for.
string
required
The service type key to filter availability (e.g., ‘regular_cleaning.one_hour’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIDY_LIST_GUEST_RESERVATIONSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIDY_LIST_TO_DO_LISTSTool 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

string
Filter to-do lists by address identifier. Supports single value (e.g., ‘1’) or comma-separated multiple values (e.g., ‘1,2’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIDY_RETRIEVE_ADDRESSTool 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

string
required
The unique identifier of the address to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIDY_UPDATE_ADDRESSTool 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

object
Notes about property access and closing procedures for updating an address.
object
Parking information for updating an address.
string
required
The unique identifier of the address to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not