- Category: project management
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 97
- Triggers: 0
- Slug:
ROUTE4ME - Version: 20261101_00
Tools
Add Order Custom Field
Add Order Custom Field
ROUTE4ME_ADD_ORDER_CUSTOM_FIELDTool to add a new custom field definition for orders. Use when you need to create additional data fields to capture order-specific information beyond the standard order properties.Input Parameters
Output
Add Route Note
Add Route Note
ROUTE4ME_ADD_ROUTE_NOTEAdd a note to an address destination on a route. Use it to record delivery status, customer feedback, or activity at a specific stop.Input Parameters
Output
Create Address
Create Address
Create Avoidance Zone
Create Avoidance Zone
ROUTE4ME_CREATE_AVOIDANCE_ZONETool to create an avoidance zone with circular, rectangular, or polygon shape. Use when you need to define geographic regions that routes should avoid, such as construction areas, restricted zones, or traffic-prone regions.Input Parameters
Output
Create Location Type
Create Location Type
ROUTE4ME_CREATE_LOCATION_TYPETool to create a new location type in the address book. Use when you need to categorize locations with custom types before adding them to routes.Input Parameters
Output
Create Master Route
Create Master Route
Create Custom Note Type
Create Custom Note Type
ROUTE4ME_CREATE_NOTETool to create a new custom note type in Route4me. Use when you need to define a new category of notes with predefined selectable values for route destinations or activities.Input Parameters
Output
Create Route Optimization
Create Route Optimization
ROUTE4ME_CREATE_OPTIMIZATIONTool to create a new route optimization in Route4Me. Use when you need to optimize delivery routes, plan multi-stop trips, or generate efficient vehicle routing solutions.Input Parameters
Output
Create Optimization Profile
Create Optimization Profile
Create Order Custom Field
Create Order Custom Field
ROUTE4ME_CREATE_ORDER_CUSTOM_FIELDTool to create a new custom field definition for orders. Use when you need to define new custom data fields that can be attached to orders for tracking additional information beyond standard order fields.Input Parameters
Output
Create Orders from Contacts
Create Orders from Contacts
ROUTE4ME_CREATE_ORDERS_FROM_CONTACTSTool to create orders from address book contacts. Use when you need to generate new orders from existing contacts for a specific delivery date.Input Parameters
Output
Create Territory
Create Territory
ROUTE4ME_CREATE_TERRITORYTool to create a new territory with circular, rectangular, or polygon shape. Use when you need to define geographic regions for route planning, service areas, or operational zones.Input Parameters
Output
Create Vehicle Capacity Profile
Create Vehicle Capacity Profile
Delete Address from Route
Delete Address from Route
Delete Addresses
Delete Addresses
Delete Avoidance Zone
Delete Avoidance Zone
Delete Configuration Setting
Delete Configuration Setting
Delete Current User
Delete Current User
Delete Location Type
Delete Location Type
Delete Optimization
Delete Optimization
ROUTE4ME_DELETE_OPTIMIZATIONDelete optimization problems by ID from the Route4Me database, for example to clean up records that are no longer needed. The reported removed count may reflect the number requested rather than the number actually deleted.Input Parameters
Output
Delete Optimization Profile
Delete Optimization Profile
Delete Order Custom Field
Delete Order Custom Field
Delete Route V4
Delete Route V4
ROUTE4ME_DELETE_ROUTE_V4Tool to delete one or more routes by route_id. Use when you need to permanently remove routes from the system. Supports single or multiple route deletion via comma-separated route_ids.Input Parameters
Output
Delete Territory
Delete Territory
Delete Vehicle Capacity Profile by ID
Delete Vehicle Capacity Profile by ID
Dispatch Routes
Dispatch Routes
ROUTE4ME_DISPATCH_ROUTESTool to approve or revoke routes for execution in Route4Me. Use when you need to set approval status for routes based on filters like route ID, vehicle ID, member ID, route status, or schedule date.Input Parameters
Output
Display Datatable Config
Display Datatable Config
Duplicate Routes
Duplicate Routes
ROUTE4ME_DUPLICATE_ROUTESTool to duplicate one or more existing routes. Use when you need to create copies of routes for similar deliveries or to use an existing route as a template.Input Parameters
Output
Find Address
Find Address
Geocode Address
Geocode Address
Geocode Address (Body)
Geocode Address (Body)
Bulk Geocode Addresses
Bulk Geocode Addresses
Geocode Address Forward
Geocode Address Forward
ROUTE4ME_GEOCODE_ADDRESS_FORWARDTool to convert an address to geographic coordinates using forward geocoding. Use when you need latitude/longitude from an address string for route planning or location-based services.Input Parameters
Output
Get Activity Feed
Get Activity Feed
ROUTE4ME_GET_ACTIVITYTool to retrieve activities from the Route4Me activity feed with optional filtering and pagination. Use when you need to track changes, monitor team actions, or audit route modifications.Input Parameters
Output
Get Address
Get Address
Get Address Book Groups
Get Address Book Groups
Get Addresses from Address Book
Get Addresses from Address Book
ROUTE4ME_GET_ADDRESSES_FROM_ADDRESSBOOKTool to retrieve addresses from the Route4Me address book. Use when you need to list contacts, search for specific addresses, or paginate through the address book. Supports filtering by address IDs and pagination with limit/offset.Input Parameters
Output
Get Async Export Tracking History
Get Async Export Tracking History
ROUTE4ME_GET_ASYNC_EXPORTRequest an asynchronous export of device tracking history in CSV, JSON, or XML format. The response may contain export status or a job ID, or raw file content.Input Parameters
Output
Get All Territories (Avoidance Zones v5)
Get All Territories (Avoidance Zones v5)
ROUTE4ME_GET_AVOIDANCE2Retrieve avoidance zones (territories) using the v4 API, optionally filtered by geographic location and distance for route planning.Input Parameters
Output
Get Avoidance Zone By ID
Get Avoidance Zone By ID
Get Clustered Locations
Get Clustered Locations
Get Current Member Information
Get Current Member Information
Get Activity Feed
Get Activity Feed
Get Last Scheduled Route for Member
Get Last Scheduled Route for Member
ROUTE4ME_GET_LAST_SCHEDULED_ROUTE_MEMBERTool to retrieve the most recently scheduled route for a specific member as of today. Use when you need route details including waypoints, optimization settings, and delivery metrics for a team member.Input Parameters
Output
Get Location Heatmap
Get Location Heatmap
ROUTE4ME_GET_LOCATION_HEATMAPTool to retrieve a heat map of location clusters from the address book. Use when visualizing location density or analyzing geographic distribution of stops.Input Parameters
Output
Get Location Service-Time Heatmap
Get Location Service-Time Heatmap
ROUTE4ME_GET_LOCATION_SERVICETIME_HEATMAPTool to retrieve location service-time heatmap data for address book locations. Use when analyzing historical service times and performance metrics for specific locations over a trailing 30-day period.Input Parameters
Output
Get Location Type
Get Location Type
Get Member Configuration Settings
Get Member Configuration Settings
ROUTE4ME_GET_MEMBER_CONFIGURATION_SETTINGSTool to get member configuration settings with optional filtering. Use when you need to retrieve specific configuration settings by mcs or config_key parameters.Input Parameters
Output
Get Note Custom Types
Get Note Custom Types
Get Optimization Profile
Get Optimization Profile
ROUTE4ME_GET_OPTIMIZATION_PROFILETool to retrieve detailed information about an optimization profile by its unique identifier. Use when you need to view the configuration settings, constraints, and optimization parameters of a specific profile before creating or planning routes.Input Parameters
Output
Get Route Destination By ID
Get Route Destination By ID
Get Route Info
Get Route Info
ROUTE4ME_GET_ROUTE_INFOTool to get detailed route information by route ID. Use when you need comprehensive details about a specific route including waypoints, optimization settings, delivery details, and turn-by-turn directions.Input Parameters
Output
Get Route List
Get Route List
ROUTE4ME_GET_ROUTE_LISTTool to retrieve a list of routes with filtering and pagination. Returns detailed route information including status, assignments, destinations, distances, and delivery metrics. Use when you need to query routes by various criteria such as date, vehicle, driver, or status.Input Parameters
Output
Get Route Settings
Get Route Settings
ROUTE4ME_GET_ROUTE_SETTINGSTool to get route settings with detailed information including waypoints, optimization settings, and delivery details. Use when you need comprehensive configuration data for a specific route including all stops, delivery parameters, and optimization settings.Input Parameters
Output
Get Territories with Location Counts
Get Territories with Location Counts
ROUTE4ME_GET_TERRITORIES_WITH_LOCATION_COUNTSTool to retrieve territories with location counts for geographic analysis. Use when you need to analyze address distribution across territories or understand coverage areas.Input Parameters
Output
Get Territory
Get Territory
Submit Device Tracking Data
Submit Device Tracking Data
Get Tracking History Export
Get Tracking History Export
ROUTE4ME_GET_TRACKING_HISTORY_EXPORTTool to export tracking history file from Route4Me. Use when you need to retrieve device location history for analysis, reporting, or compliance purposes. Supports filtering by device, member, route, and time range.Input Parameters
Output
Get User By ID
Get User By ID
Get User Locations
Get User Locations
Get User Modification History
Get User Modification History
ROUTE4ME_GET_USER_MODIFICATION_HISTORYTool to get user modification history from Route4Me. Returns detailed audit trail of changes made to a user’s account including field modifications, timestamps, and who initiated the changes. Use when you need to track user account changes or audit user information updates.Input Parameters
Output
Get User Template
Get User Template
Get User Information (v4)
Get User Information (v4)
Get Vehicles
Get Vehicles
Get Vehicle Capacity Profile As Datatable
Get Vehicle Capacity Profile As Datatable
ROUTE4ME_GET_VEHICLE_CAPACITY_PROFILE_AS_DATATABLETool to retrieve vehicle capacity profiles in datatable format with pagination. Use when you need to view capacity profiles for vehicles including weight, volume, revenue, and items limits.Input Parameters
max_volume, asc], [max_revenue, desc]]Output
Get Vehicle Capacity Profile by ID
Get Vehicle Capacity Profile by ID
Get Vehicle Capacity Profile Page Config
Get Vehicle Capacity Profile Page Config
Get Vehicle Capacity Profiles
Get Vehicle Capacity Profiles
ROUTE4ME_GET_VEHICLE_CAPACITY_PROFILESTool to retrieve vehicle capacity profiles with weight, volume, and item constraints. Use when you need to view available capacity profiles for route planning or vehicle assignment.Input Parameters
Output
List Location Types
List Location Types
List Optimization Profiles
List Optimization Profiles
List Optimizations
List Optimizations
ROUTE4ME_LIST_OPTIMIZATIONSTool to get a list of all optimizations or retrieve a single optimization by ID. Use when you need to view optimization details, check optimization status, or filter optimizations by state or date range.Input Parameters
Output
List Order Custom Fields
List Order Custom Fields
List Route Directions
List Route Directions
ROUTE4ME_LIST_ROUTE_DIRECTIONSTool to get detailed route directions including turn-by-turn navigation information for each stop. Use when you need comprehensive direction details for a specific route including stop sequences, addresses, coordinates, and status information.Input Parameters
Output
List Team Users
List Team Users
List Users By IDs
List Users By IDs
List Team Users (Paginated)
List Team Users (Paginated)
ROUTE4ME_LIST_USERS_PAGINATEDTool to get a paginated list of team members/users in the account. Use when you need to retrieve team members with pagination support, search filtering, or when dealing with large teams where retrieving all users at once is not practical.Input Parameters
[["field_name", "asc"]] or [["field_name", "desc"]].Output
Lookup For New Destination
Lookup For New Destination
ROUTE4ME_LOOKUP_FOR_NEW_DESTINATIONTool to lookup optimal routes for inserting a new destination. Use when you need to find the best existing route(s) to add a new stop to, based on distance or time optimization.Input Parameters
Output
Merge Routes
Merge Routes
ROUTE4ME_MERGE_ROUTESMerge destinations from multiple routes into a single target route to consolidate routes. The returned success flag alone does not independently confirm that the merge occurred.Input Parameters
Output
Move Route Destination
Move Route Destination
ROUTE4ME_MOVE_ROUTEMove a destination from one route to another, placing it after a specified destination on the recipient route. Use this to reorganize routes or reassign stops. The returned success flag alone does not independently confirm that the move occurred.Input Parameters
Output
Preview Route Assignment
Preview Route Assignment
ROUTE4ME_PREVIEW_ROUTE_ASSIGNMENTTool to generate a preview of route assignments based on filters, grouping, sorting, and assignment strategy without applying changes. Returns grouped results and subtotals for review before actual assignment.Input Parameters
Output
Re-run Optimization
Re-run Optimization
Reverse Geocode Address
Reverse Geocode Address
ROUTE4ME_REVERSE_GEOCODE_ADDRESSTool to reverse geocode coordinates to obtain an address. Use when you need to convert latitude/longitude coordinates into a human-readable street address.Input Parameters
Output
Set Destination Status
Set Destination Status
Set Route Rating
Set Route Rating
Set Route Tracking Data
Set Route Tracking Data
Update Address
Update Address
Update Avoidance Zone
Update Avoidance Zone
Update Location Type
Update Location Type
ROUTE4ME_UPDATE_LOCATION_TYPETool to update an existing location type in the address book. Use when you need to modify location type details such as name, parent/child type status, or description.Input Parameters
Output
Update Member Configuration Setting
Update Member Configuration Setting
ROUTE4ME_UPDATE_MEMBER_CONFIGURATION_SETTINGTool to update a member configuration setting. Use when you need to modify account-level configuration values such as notification preferences, feature flags, or service provider settings.Input Parameters
Output
Update Custom Note Type
Update Custom Note Type
ROUTE4ME_UPDATE_NOTE_CUSTOM_TYPETool to update an existing custom note type in Route4Me. Use when you need to modify the name or values of a custom note type.Input Parameters
Output
Update Optimization Profile
Update Optimization Profile
ROUTE4ME_UPDATE_OPTIMIZATION_PROFILEUpdate an existing optimization profile’s routing preferences, constraints, or settings by ID. A profile name is required with every update.Input Parameters
Output
Update Order Custom Field
Update Order Custom Field
Update Routes
Update Routes
ROUTE4ME_UPDATE_ROUTESTool to bulk update multiple routes in a single operation. Use when you need to update route names, optimization settings, duration constraints, or reassign multiple routes to team members efficiently.Input Parameters
Output
Update Route Settings
Update Route Settings
ROUTE4ME_UPDATE_ROUTE_SETTINGSTool to update route settings including optimization parameters, distance units, and device types. Use when you need to modify route configuration such as optimization criteria, distance measurement units, or device-specific settings.Input Parameters
Output
Update Route V4
Update Route V4
Update Territory
Update Territory
Update Vehicle Capacity Profile By ID
Update Vehicle Capacity Profile By ID