RouteWren
Available on Request

API for Automatic Entry

Let another program put stops straight into RouteWren: a claims or job system, a CRM, a booking form on your website, or a spreadsheet script. No copying and pasting.

API access is included in every plan. Email us from the address on your account and we'll turn it on.

How It Works

  1. Ask us to turn on API access for your account.
  2. In the app, open Settings > More > API and make a key. Copy it: it's shown once.
  3. Your program sends stops to RouteWren with that key. They appear in your unscheduled stops, ready to plan.

Stops with the same reference # are matched, so sending a stop again updates its details instead of making a copy. Include a reference # whenever you have one so repeats are always recognized. Adding stops is free; a stop only counts toward your plan when you put it on a route.

Add Stops

POST https://routewren.com/api/v1/stops
Authorization: Bearer rwk_your_key
Content-Type: application/json

{
  "stops": [
    {
      "name": "Avery Example",
      "address": "1450 Glenmore Dr, Kelowna, BC",
      "phone": "250-555-0101",
      "email": "avery@example.com",
      "reference": "JOB-10442",
      "type": "Water damage",
      "due_date": "2026-11-05",
      "notes": "Side door, dog in yard"
    }
  ]
}

name and address are required; everything else is optional. Send up to 500 stops per call, or a single stop object on its own. The reply says how many were added, updated, unchanged or skipped:

{ "ok": true, "added": 1, "updated": 0, "unchanged": 0, "skipped": 0, "unlocated": 0, "errors": [] }

unlocated counts addresses that couldn't be found on the map. Those stops are still added; fix the address in the app.

List Stops

GET https://routewren.com/api/v1/stops?status=unscheduled
Authorization: Bearer rwk_your_key

status can be unscheduled, scheduled or all (the default). Each stop comes back with its name, reference, address, phone, email, status, and appointment date and time once it's booked.

Check a Key

GET https://routewren.com/api/v1/ping
Authorization: Bearer rwk_your_key

Limits and Good Practice

  • Up to 500 stops per call. Each key also has a generous daily call limit; if you expect heavy use, tell us when you ask for access.
  • Errors come back with an HTTP status and { "error": "..." } in plain English: 401 for a bad key, 402 if the plan isn't active, 429 when the daily limit is reached.
  • Keep keys on your server, never in a public web page. Anyone with a key can add and read your stops. Delete a key in Settings to stop it working at once.
  • Only send people who expect to hear from you. The Terms apply to stops added by the API just as to stops you add yourself.
  • Routes are deleted 14 days after their date. Stops you haven't put on a route stay until you delete them.