Developer Platform

API keys and the External API

Create an API key to let your own systems optimize routes through the Routerra Teams API — how keys work, when they're shown, and how to revoke them.

External API overview

Base URL, authentication, a first request, and how REST and the MCP connector relate — the entry point to the Routerra Teams External API reference.

API authentication & scopes

How a Routerra Teams API key authenticates over REST and MCP, what read, write and dispatch each unlock, and why a new key has no dispatch scope.

API limits & quotas

Rate limits, concurrent optimizations, the daily optimization quota and its dashboard reserve — every way a Routerra Teams API call gets refused with a 429.

Idempotent API requests

Send clientRequestId so a timed-out Routerra Teams API call can be retried without applying it twice — and what the deduplicated replay will not tell you.

API error reference

Every error code the Routerra Teams API returns, what triggers it and which ones are worth retrying — plus the date, time, unit and phone formats it expects.

Plan lifecycle & statuses

Every status a Routerra Teams plan can hold, the API calls that move it between them, and the transitions the API refuses — the plan state machine.

Team, driver & analytics endpoints

The reference data behind every plan you build — team context, drivers, the address book and delivery statistics — plus the one call that edits a driver.

Plan endpoints

POST /optimize in full — the four ways to specify a stop, dispatch=false, geocode failures and the 202 poll — plus listing, reading, cancelling and copying plans.

Plan operation endpoints

Add, edit and remove stops on an existing plan, dispatch, approve and revoke its routes, and preview what a destructive operation would cost first.

Proposed changes

How an API key without the dispatch scope queues an operation for a human dispatcher instead of failing, and the three endpoints that create, list and apply it.

MCP connector

The Routerra Teams MCP server: endpoint and headers, the 18 tools and the REST endpoint each one wraps, and every place MCP behaves differently from REST.

Response objects & enums

Field reference for the Routerra Teams API — stop, route and change objects, every enum value they can hold, what the API deliberately doesn't do, and what changed.

Webhooks

Get a signed JSON POST the moment plans, routes, and stops change — the five events, the HMAC signature, and why each event is delivered exactly once.

Connect Twilio for SMS

SMS customer notifications send through your own Twilio account. Connect it once — credentials, sender, test — and every stop can text your customers.