Spoke Dispatch MCP by usefulapi

List route plans (a plan = one day's delivery job: date, depot, drivers, routes), newest first, in pages of up to 20. Filter with e.g. {"title":"Monday run"} or {"startsGte":"2026-10-01"}. GET /plans.

{
  "type": "object",
  "properties": {
    "title": {
      "description": "Only plans with this title.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "starts_on_or_after": {
      "description": "Only plans starting on or after this date (yyyy-mm-dd).",
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
    },
    "filter": {
      "description": "Extra filter fields as documented by Spoke (name -> value), e.g. {\"startsGte\":\"2026-10-01\"}.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 200
          },
          {
            "type": "boolean"
          }
        ]
      }
    },
    "max_page_size": {
      "description": "Results per page, 1-20 (default 10).",
      "type": "integer",
      "minimum": 1,
      "maximum": 20
    },
    "page_token": {
      "description": "Page token: pass the previous reply's nextPageToken (with the same other arguments) for the next page.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

One plan: title, start date, depot, driver ids, route ids, whether it is distributed/writable, optimization state and route overrides. GET /plans/{planId}.

{
  "type": "object",
  "properties": {
    "plan_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "description": "Plan id, e.g. 'abc123' or 'plans/abc123'."
    }
  },
  "required": [
    "plan_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List the stops of a plan, in pages of up to 10. Stops include recipient names, phones, e-mails and addresses (personal data): page only as far as needed. GET /plans/{planId}/stops.

{
  "type": "object",
  "properties": {
    "plan_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "recipient_external_id": {
      "description": "Only stops whose recipient has this external id.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "max_page_size": {
      "description": "Results per page, 1-10 (default 10).",
      "type": "integer",
      "minimum": 1,
      "maximum": 10
    },
    "page_token": {
      "description": "Page token: pass the previous reply's nextPageToken (with the same other arguments) for the next page.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    }
  },
  "required": [
    "plan_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

One stop of a plan with address, recipient, timing, ETA, route and delivery outcome (attempted, succeeded, notes, photo/signature links). Contains personal data. GET /plans/{planId}/stops/{stopId}.

{
  "type": "object",
  "properties": {
    "plan_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "stop_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "Stop id, e.g. 'xyz' or 'plans/abc/stops/xyz'."
    }
  },
  "required": [
    "plan_id",
    "stop_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Search all stops of the team (planned, unassigned, past) by keyword and/or Spoke's filter language, up to 20 per page. Example filter: address.countryCode = "DE" and deliveryInfo.attempted = false. Filterable: planId, routeId, type, activity, notes, address.*, createdAt, recipient.name/email/phone/externalId, deliveryInfo.state/attempted/succeeded, orderInfo.*. Results include personal data. The search index lags real time by a short while. GET /stops:search.

{
  "type": "object",
  "properties": {
    "keyword": {
      "description": "Fuzzy full-text keywords.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "filter": {
      "description": "Spoke filter expression, e.g. createdAt >= \"2026-10-01T00:00:00Z\" and address ~= \"London\".",
      "type": "string",
      "minLength": 1,
      "maxLength": 2048
    },
    "sort_field": {
      "type": "string",
      "enum": [
        "address.latitude",
        "address.longitude",
        "createdAt",
        "arrivalAt",
        "packageCount",
        "estimatedTravelDuration",
        "estimatedTravelDistance",
        "timing.estimatedAttemptDuration",
        "deliveryInfo.attemptedAt",
        "paymentOnDelivery.amount"
      ]
    },
    "sort_order": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "max_page_size": {
      "description": "Results per page, 1-20 (default 20).",
      "type": "integer",
      "minimum": 1,
      "maximum": 20
    },
    "page_token": {
      "description": "Page token: pass the previous reply's nextPageToken (with the same other arguments) for the next page.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List stops that are not on any plan yet (the inbox of imported orders), in pages of up to 20 (default 20). Contains personal data. GET /unassignedStops.

{
  "type": "object",
  "properties": {
    "max_page_size": {
      "description": "Results per page, 1-20 (default 20).",
      "type": "integer",
      "minimum": 1,
      "maximum": 20
    },
    "page_token": {
      "description": "Page token: pass the previous reply's nextPageToken (with the same other arguments) for the next page.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

One unassigned stop by id. Contains personal data. GET /unassignedStops/{id}.

{
  "type": "object",
  "properties": {
    "unassigned_stop_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "Id, e.g. 'abc' or 'unassignedStops/abc'."
    }
  },
  "required": [
    "unassigned_stop_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List the team's drivers (name, e-mail/phone, active flag, depots, route overrides), up to 50 per page. Contains personal data. GET /drivers.

{
  "type": "object",
  "properties": {
    "active": {
      "description": "Only active (true) or inactive (false) drivers.",
      "type": "boolean"
    },
    "max_page_size": {
      "description": "Results per page, 1-50 (default 50).",
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    },
    "page_token": {
      "description": "Page token: pass the previous reply's nextPageToken (with the same other arguments) for the next page.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

One driver by id. Contains personal data. GET /drivers/{driverId}.

{
  "type": "object",
  "properties": {
    "driver_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "description": "Driver id, e.g. 'abc' or 'drivers/abc'."
    }
  },
  "required": [
    "driver_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List depots (start/end addresses, working hours, vehicle type, max stops), up to 20 per page. Use the ids when creating plans. GET /depots.

{
  "type": "object",
  "properties": {
    "max_page_size": {
      "description": "Results per page, 1-20 (default 20).",
      "type": "integer",
      "minimum": 1,
      "maximum": 20
    },
    "page_token": {
      "description": "Page token: pass the previous reply's nextPageToken (with the same other arguments) for the next page.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

One depot by id. GET /depots/{depotId}.

{
  "type": "object",
  "properties": {
    "depot_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "description": "Depot id, e.g. 'abc' or 'depots/abc'."
    }
  },
  "required": [
    "depot_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List routes (one driver's run of a plan: stop count, driver, distributed/started/completed state), up to 20 per page. GET /routes.

{
  "type": "object",
  "properties": {
    "starts_on_or_after": {
      "description": "Only routes of plans starting on or after this date (yyyy-mm-dd).",
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
    },
    "max_page_size": {
      "description": "Results per page, 1-20 (default 20).",
      "type": "integer",
      "minimum": 1,
      "maximum": 20
    },
    "page_token": {
      "description": "Page token: pass the previous reply's nextPageToken (with the same other arguments) for the next page.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

One route: title, driver, stop count and state (distributed, started, completed, recipients notified). GET /routes/{routeId}.

{
  "type": "object",
  "properties": {
    "route_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "description": "Route id, e.g. 'abc' or 'routes/abc'."
    }
  },
  "required": [
    "route_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List the stops of one route in driving order, in pages of up to 10. Contains personal data: page only as far as needed. GET /routes/{routeId}/stops.

{
  "type": "object",
  "properties": {
    "route_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "recipient_external_id": {
      "description": "Only stops whose recipient has this external id.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "max_page_size": {
      "description": "Results per page, 1-10 (default 10).",
      "type": "integer",
      "minimum": 1,
      "maximum": 10
    },
    "page_token": {
      "description": "Page token: pass the previous reply's nextPageToken (with the same other arguments) for the next page.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    }
  },
  "required": [
    "route_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List long-running operations (plan optimizations): type, done flag, who started it, result (optimized and skipped stops), up to 20 per page. GET /operations.

{
  "type": "object",
  "properties": {
    "max_page_size": {
      "description": "Results per page, 1-20 (default 20).",
      "type": "integer",
      "minimum": 1,
      "maximum": 20
    },
    "page_token": {
      "description": "Page token: pass the previous reply's nextPageToken (with the same other arguments) for the next page.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

One operation, e.g. the optimization started by spoke_optimize_plan: poll until done is true. GET /operations/{operationId}.

{
  "type": "object",
  "properties": {
    "operation_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "description": "Operation id, e.g. 'abc' or 'operations/abc'."
    }
  },
  "required": [
    "operation_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

The team's custom stop property definitions (ids and names). Their ids are the keys of customProperties on stops. Needs a subscription that includes custom properties (HTTP 403 otherwise). GET /team/customStopProperties.

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

WRITE: create a new route plan for a date (no stops yet, nothing is sent to drivers). Optionally assign drivers (up to 50, they must be active and share the plan's depot) and a depot (default: the team's main depot). Does not optimize or distribute. POST /plans.

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "starts_on": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Plan date, yyyy-mm-dd (Spoke rejects dates too far in the past or future)."
    },
    "driver_ids": {
      "description": "Driver ids ('abc' or 'drivers/abc').",
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 60
      }
    },
    "depot_id": {
      "description": "Depot id ('abc' or 'depots/abc').",
      "type": "string",
      "minLength": 1,
      "maxLength": 60
    }
  },
  "required": [
    "title",
    "starts_on"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

WRITE: change a plan's title, date, drivers and/or depot. Only the fields you pass change, but driver_ids REPLACES the plan's whole driver list. Fails if the plan is not writable (already distributed). Nothing is sent to drivers. PATCH /plans/{planId}.

{
  "type": "object",
  "properties": {
    "plan_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "starts_on": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
    },
    "driver_ids": {
      "description": "The complete new driver list (replaces the old one).",
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 60
      }
    },
    "depot_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 60
    }
  },
  "required": [
    "plan_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

WRITE: add one stop to a writable (not yet distributed) plan. Needs an address (text fields or latitude+longitude). The recipient's phone/e-mail are stored on the stop and Spoke may contact the recipient later when the route runs; nothing is sent now. For many stops use spoke_import_stops. POST /plans/{planId}/stops.

{
  "type": "object",
  "properties": {
    "plan_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "stop": {
      "type": "object",
      "properties": {
        "address": {
          "type": "object",
          "properties": {
            "address_name": {
              "description": "Display name only (not used for geocoding), e.g. 'Rear entrance'.",
              "type": "string",
              "minLength": 1,
              "maxLength": 255
            },
            "address_line_one": {
              "type": "string",
              "minLength": 1,
              "maxLength": 255
            },
            "address_line_two": {
              "type": "string",
              "minLength": 1,
              "maxLength": 255
            },
            "city": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "state": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "zip": {
              "type": "string",
              "minLength": 1,
              "maxLength": 40
            },
            "country": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "latitude": {
              "description": "Overrides the text fields; give both latitude and longitude or neither.",
              "type": "number",
              "minimum": -90,
              "maximum": 90
            },
            "longitude": {
              "type": "number",
              "minimum": -180,
              "maximum": 180
            }
          },
          "description": "Stop address. Give at least one field; the more fields, the better the geocoding."
        },
        "recipient_name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "recipient_phone": {
          "description": "Recipient phone (E.164 preferred). Stored on the stop; Spoke may text it when the route runs.",
          "type": "string",
          "minLength": 3,
          "maxLength": 40
        },
        "recipient_email": {
          "description": "Recipient e-mail. Stored on the stop; Spoke may e-mail tracking updates when the route runs.",
          "type": "string",
          "maxLength": 254,
          "format": "email",
          "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
        },
        "recipient_external_id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "notes": {
          "description": "Notes for the driver.",
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        },
        "package_count": {
          "type": "integer",
          "minimum": 1,
          "maximum": 10000
        },
        "activity": {
          "description": "Default delivery.",
          "type": "string",
          "enum": [
            "delivery",
            "pickup"
          ]
        },
        "optimization_order": {
          "description": "Force the stop first or last in the optimized route.",
          "type": "string",
          "enum": [
            "default",
            "first",
            "last"
          ]
        },
        "earliest_attempt_time": {
          "description": "Time window start, HH:MM (local time of the stop).",
          "type": "string",
          "pattern": "^([01]\\d|2[0-3]):([0-5]\\d)$"
        },
        "latest_attempt_time": {
          "description": "Time window end, HH:MM.",
          "type": "string",
          "pattern": "^([01]\\d|2[0-3]):([0-5]\\d)$"
        },
        "estimated_attempt_duration_seconds": {
          "description": "Expected time at the stop, in seconds.",
          "type": "integer",
          "minimum": 1,
          "maximum": 28800
        },
        "allowed_driver_ids": {
          "description": "Only these drivers (ids or 'drivers/<id>'; they must be on the plan) may serve the stop.",
          "maxItems": 50,
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 60
          }
        },
        "seller_order_id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "invoice_number": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "products": {
          "description": "Product names for the stop.",
          "maxItems": 100,
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          }
        }
      },
      "required": [
        "address"
      ]
    }
  },
  "required": [
    "plan_id",
    "stop"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

WRITE: add up to 100 stops to a writable (not yet distributed) plan in one request (better geocoding than one at a time; Spoke limits imports to 30 requests a minute). Returns the created stop ids and any failures. Recipient contact data is stored on the stops; nothing is sent now. POST /plans/{planId}/stops:import.

{
  "type": "object",
  "properties": {
    "plan_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "stops": {
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "address": {
            "type": "object",
            "properties": {
              "address_name": {
                "description": "Display name only (not used for geocoding), e.g. 'Rear entrance'.",
                "type": "string",
                "minLength": 1,
                "maxLength": 255
              },
              "address_line_one": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255
              },
              "address_line_two": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255
              },
              "city": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "state": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "zip": {
                "type": "string",
                "minLength": 1,
                "maxLength": 40
              },
              "country": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "latitude": {
                "description": "Overrides the text fields; give both latitude and longitude or neither.",
                "type": "number",
                "minimum": -90,
                "maximum": 90
              },
              "longitude": {
                "type": "number",
                "minimum": -180,
                "maximum": 180
              }
            },
            "description": "Stop address. Give at least one field; the more fields, the better the geocoding."
          },
          "recipient_name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          },
          "recipient_phone": {
            "description": "Recipient phone (E.164 preferred). Stored on the stop; Spoke may text it when the route runs.",
            "type": "string",
            "minLength": 3,
            "maxLength": 40
          },
          "recipient_email": {
            "description": "Recipient e-mail. Stored on the stop; Spoke may e-mail tracking updates when the route runs.",
            "type": "string",
            "maxLength": 254,
            "format": "email",
            "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
          },
          "recipient_external_id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          },
          "notes": {
            "description": "Notes for the driver.",
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "package_count": {
            "type": "integer",
            "minimum": 1,
            "maximum": 10000
          },
          "activity": {
            "description": "Default delivery.",
            "type": "string",
            "enum": [
              "delivery",
              "pickup"
            ]
          },
          "optimization_order": {
            "description": "Force the stop first or last in the optimized route.",
            "type": "string",
            "enum": [
              "default",
              "first",
              "last"
            ]
          },
          "earliest_attempt_time": {
            "description": "Time window start, HH:MM (local time of the stop).",
            "type": "string",
            "pattern": "^([01]\\d|2[0-3]):([0-5]\\d)$"
          },
          "latest_attempt_time": {
            "description": "Time window end, HH:MM.",
            "type": "string",
            "pattern": "^([01]\\d|2[0-3]):([0-5]\\d)$"
          },
          "estimated_attempt_duration_seconds": {
            "description": "Expected time at the stop, in seconds.",
            "type": "integer",
            "minimum": 1,
            "maximum": 28800
          },
          "allowed_driver_ids": {
            "description": "Only these drivers (ids or 'drivers/<id>'; they must be on the plan) may serve the stop.",
            "maxItems": 50,
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 60
            }
          },
          "seller_order_id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          },
          "invoice_number": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          },
          "products": {
            "description": "Product names for the stop.",
            "maxItems": 100,
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 255
            }
          }
        },
        "required": [
          "address"
        ]
      }
    }
  },
  "required": [
    "plan_id",
    "stops"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

WRITE: start the route optimization of a plan (orders and assigns its stops to its drivers). Rewrites the plan's routes if it was optimized before, and uses Spoke's optimization quota (30 per minute, 100 per 10 minutes). Does NOT send anything to drivers. Returns an operation: poll spoke_get_operation until done. Needs at least one driver and one stop. POST /plans/{planId}:optimize.

{
  "type": "object",
  "properties": {
    "plan_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    }
  },
  "required": [
    "plan_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

WRITE (SENDS TO REAL PEOPLE): distribute an optimized plan, which immediately sends each driver of the plan their route on their phone (push notification / message) and locks the plan for edits. Cannot be undone. Only for a plan with 1-10 drivers, and only after the user has explicitly said to send the routes: set confirm_send_to_drivers to true. POST /plans/{planId}:distribute.

{
  "type": "object",
  "properties": {
    "plan_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "confirm_send_to_drivers": {
      "type": "boolean",
      "const": true,
      "description": "Must be true: confirms the user asked to send the routes to the plan's drivers now."
    }
  },
  "required": [
    "plan_id",
    "confirm_send_to_drivers"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}