API_KEY
route4me_api_key
Developer setup
No fields declared in this snapshot.
User connection
- Route4Me API Keygeneric_api_key · stringRequired
ROUTE4ME
Route4Me provides a Last Mile Routing API offering automated solutions for route planning and optimization, tailored for logistics-intensive businesses.
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
97
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
API_KEY
No fields declared in this snapshot.
Capability index
Showing 61–90 of 97 actions
ROUTE4ME_GET_USER_MODIFICATION_HISTORY
Tool 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.
Untrusted display-only summary
ROUTE4ME_GET_USER_TEMPLATE
Tool to retrieve the template of a sub-user with detailed information including contact information, preferences, and account status. Use when you need to get the user template structure or default user configuration.
Untrusted display-only summary
ROUTE4ME_GET_USER_V4
Tool to retrieve authenticated user information in v4 format. Use when you need to get details about the currently authenticated user including member ID, email, name, account type, and preferences.
Untrusted display-only summary
ROUTE4ME_GET_VEHICLE
Tool to retrieve details of vehicles in the organization. Use when you need the full list of vehicles before planning routes or auditing vehicle capacities.
Untrusted display-only summary
ROUTE4ME_GET_VEHICLE_CAPACITY_PROFILE_AS_DATATABLE
Tool 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.
Untrusted display-only summary
ROUTE4ME_GET_VEHICLE_CAPACITY_PROFILE_BY_ID
Tool to retrieve a specific vehicle capacity profile by its ID. Use when you need details of a particular capacity profile for route planning or vehicle configuration.
Untrusted display-only summary
ROUTE4ME_GET_VEHICLE_CAPACITY_PROFILE_PAGE_CONFIG
Tool to retrieve vehicle capacity profile page configuration including unit settings. Use when you need to understand available units for volume, weight, and revenue in vehicle capacity profiles.
Untrusted display-only summary
ROUTE4ME_GET_VEHICLE_CAPACITY_PROFILES
Tool 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.
Untrusted display-only summary
ROUTE4ME_LIST_LOCATION_TYPES
Tool to retrieve location type definitions used in the address book system. Use when categorizing addresses or locations in Route4Me.
Untrusted display-only summary
ROUTE4ME_LIST_OPTIMIZATION_PROFILES
Tool to retrieve optimization profiles with settings and configuration details. Use when you need to view available optimization profiles, check profile settings, or select a profile for route optimization.
Untrusted display-only summary
ROUTE4ME_LIST_OPTIMIZATIONS
Tool 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.
Untrusted display-only summary
ROUTE4ME_LIST_ORDER_CUSTOM_FIELDS
Tool to retrieve all order custom field definitions from Route4Me v5.0 API. Use when you need to understand what custom fields are available for orders, including their types, labels, and configuration details.
Untrusted display-only summary
ROUTE4ME_LIST_ROUTE_DIRECTIONS
Tool 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.
Untrusted display-only summary
ROUTE4ME_LIST_TEAM_USERS
Tool to get the list of team members/users in the account. Use when you need to view all members, their roles, permissions, and contact information.
Untrusted display-only summary
ROUTE4ME_LIST_USERS_BY_IDS
Tool to retrieve detailed information about team members by their member IDs. Use when you need to get specific user details for one or more members by their IDs.
Untrusted display-only summary
ROUTE4ME_LIST_USERS_PAGINATED
Tool 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.
Untrusted display-only summary
ROUTE4ME_LOOKUP_FOR_NEW_DESTINATION
Tool 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.
Untrusted display-only summary
ROUTE4ME_MERGE_ROUTES
Tool to merge multiple routes into a single target route. Use when consolidating routes to optimize delivery operations or reduce the number of active routes.
Untrusted display-only summary
ROUTE4ME_MOVE_ROUTE
Tool to move a destination from one route to another. Use when reorganizing routes or reassigning stops between different routes.
Untrusted display-only summary
ROUTE4ME_PREVIEW_ROUTE_ASSIGNMENT
Tool 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.
Untrusted display-only summary
ROUTE4ME_RERUN_OPTIMIZATION
Tool to re-optimize an existing optimization problem by updating route parameters and/or addresses. Use when you need to modify an existing route optimization with new parameters or address changes.
Untrusted display-only summary
ROUTE4ME_REVERSE_GEOCODE_ADDRESS
Tool to reverse geocode coordinates to obtain an address. Use when you need to convert latitude/longitude coordinates into a human-readable street address.
Untrusted display-only summary
ROUTE4ME_SET_DESTINATION_STATUS
Tool to set or update the status of a route destination. Use after confirming deliveries to mark stops as visited or departed.
Untrusted display-only summary
ROUTE4ME_SET_ROUTE_RATING
Tool to set a rating for a route. Use when you need to record user feedback or satisfaction level for a completed route.
Untrusted display-only summary
ROUTE4ME_SET_TRACKING
Tool to insert tracking data for a route. Use when you need to update the real-time location and status of a vehicle or driver on a route.
Untrusted display-only summary
ROUTE4ME_UPDATE_ADDRESS
Tool to update an existing address in the Route4Me address book. Use when you need to modify contact details, location information, or time windows for an address.
Untrusted display-only summary
ROUTE4ME_UPDATE_AVOIDANCE
Tool to update an existing avoidance zone. Use when you need to modify the name, color, or geographic boundaries of an avoidance zone for route planning.
Untrusted display-only summary
ROUTE4ME_UPDATE_LOCATION_TYPE
Tool 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.
Untrusted display-only summary
ROUTE4ME_UPDATE_MEMBER_CONFIGURATION_SETTING
Tool 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.
Untrusted display-only summary
ROUTE4ME_UPDATE_NOTE_CUSTOM_TYPE
Tool to update an existing custom note type in Route4Me. Use when you need to modify the name or values of a custom note type.
Untrusted display-only summary
Provenance
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.