NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Tidy connects to a Nagent workspace with an API key. Once it is connected, agents can call 10 Tidy actions, such as "Create Address", "Create Pro" and "List All Addresses". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Tidy, with input parameters and output schema.
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
City name.
Apartment or unit number.
Notes about property access and closing procedures.
Street name and number (e.g., '123 Main St').
Country code (e.g., 'US').
Parking information object containing parking details.
Postal/ZIP code (e.g., '92626').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Full name of the Pro to add to the Priority List.
Email address of the Pro. Must be a valid email format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The unique identifier of the address to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TIDY_LIST_ALL_JOBSTool 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
Page number for pagination (starts at 1). Use to retrieve subsequent pages of results.
Filter jobs by status. Supports single or comma-separated multiple values. Accepted values: 'scheduled', 'in_progress', 'completed', 'cancelled', 'failed'.
Number of jobs to return per page (max 100). Controls the page size of results.
Filter jobs by address identifier. Supports single value (e.g., '1') or comma-separated multiple values (e.g., '1,2').
Filter jobs by to-do list identifier. Supports single value (e.g., '1') or comma-separated multiple values (e.g., '1,2').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The identifier of the address to check availability for.
The service type key to filter availability (e.g., 'regular_cleaning.one_hour').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Filter to-do lists by address identifier. Supports single value (e.g., '1') or comma-separated multiple values (e.g., '1,2').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The unique identifier of the address to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Notes about property access and closing procedures for updating an address.
Parking information for updating an address.
The unique identifier of the address to update.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 10 Tidy actions on Nagent, including "Create Address", "Create Pro" and "List All Addresses". Create Address: Create a new address record with location data, parking information, and access instructions. Each action is listed on this page with its input parameters and its output.
Tidy connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Address takes 4 required inputs: address, country, parking and postal_code. It also takes 3 optional inputs: city, unit and notes. It returns data, error and successful.