Welcome

The Routal API is a REST/JSON interface served from https://api.routal.com. Every request is authenticated with a private_key query parameter, every response is JSON, and every endpoint is documented and versioned.

Start here

• Quickstart — go from zero to a successful API call in under five minutes.
• Build with AI — a pasteable context block to make Claude / Cursor / Copilot produce correct Routal code on the first try.
• Recipes — end-to-end, runnable walkthroughs for the most common integration scenarios (TS + Python + cURL).
• Authentication — how API keys work, where to issue them, and how to rotate them.
• Errors — every HTTP status, every machine code, and what to do about each one.
• Rate limits — quotas, headers, and recommended backoff.
• Webhooks — subscribe to plan, route, and stop lifecycle events.

The resource model

Four resources cover the core domain:

• Plans — group stops, routes, and vehicles for a delivery window. Create, optimize, and dispatch plans programmatically.
• Routes — ordered sequence of stops served by a single vehicle. Retrieve, mutate, and dispatch routes.
• Stops — individual delivery or service tasks. Create, update, move between routes, and geocode addresses.
• Vehicles — fleet resources that execute routes. Manage capacity, skills, and shifts.

Explore each in the API Reference in the sidebar.

Conventions

• All timestamps are ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) in UTC.
• Coordinates use { lat, lng } as decimal degrees in WGS 84.
• IDs are 24-character hex strings.
• Pagination uses ?offset=N&limit=M. Responses include total.

Status & support

• Operational status: routal.statuspage.io
• Security and compliance: trust.routal.com
• Developer articles: Routal support — developers collection