Servers Playground How we check Add a server Log in

Spoke Dispatch MCP by usefulapi

Working · 681 ms

io.usefulapi/spoke-dispatchv1.6.0 Domain verified

Read Spoke Dispatch plans, stops, routes and drivers; create and optimize plans; send routes.

Maps & Travel

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://spoke-dispatch.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

spoke_create_plan

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.

titlestring, required

starts_onstring, required

Plan date, yyyy-mm-dd (Spoke rejects dates too far in the past or future).

depot_idstring

Depot id ('abc' or 'depots/abc').

driver_idsarray

Driver ids ('abc' or 'drivers/abc').

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

Spoke Dispatch MCP by usefulapi MCP server | mcptry

Tools (23)

spoke_create_plan

Argument	Type	Description
title*	string
depot_id	string	Depot id ('abc' or 'depots/abc').
starts_on*	string	Plan date, yyyy-mm-dd (Spoke rejects dates too far in the past or future).
driver_ids	array	Driver ids ('abc' or 'drivers/abc').

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "title",
    "starts_on"
  ],
  "properties": {
    "title": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1
    },
    "depot_id": {
      "type": "string",
      "maxLength": 60,
      "minLength": 1,
      "description": "Depot id ('abc' or 'depots/abc')."
    },
    "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": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 60,
        "minLength": 1
      },
      "maxItems": 50,
      "description": "Driver ids ('abc' or 'drivers/abc')."
    }
  }
}

spoke_create_stop

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.

Argument	Type	Description
stop*	object
plan_id*	string

Input schema (JSON)

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

spoke_distribute_plan

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.

destructive

Argument	Type	Description
plan_id*	string
confirm_send_to_drivers*	boolean	Must be true: confirms the user asked to send the routes to the plan's drivers now.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "plan_id",
    "confirm_send_to_drivers"
  ],
  "properties": {
    "plan_id": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1
    },
    "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."
    }
  }
}

spoke_get_depot

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

read-only

Argument	Type	Description
depot_id*	string	Depot id, e.g. 'abc' or 'depots/abc'.

Input schema (JSON)

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

spoke_get_driver

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

read-only

Argument	Type	Description
driver_id*	string	Driver id, e.g. 'abc' or 'drivers/abc'.

Input schema (JSON)

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

spoke_get_operation

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

read-only

Argument	Type	Description
operation_id*	string	Operation id, e.g. 'abc' or 'operations/abc'.

Input schema (JSON)

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

spoke_get_plan

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

read-only

Argument	Type	Description
plan_id*	string	Plan id, e.g. 'abc123' or 'plans/abc123'.

Input schema (JSON)

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

spoke_get_route

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

read-only

Argument	Type	Description
route_id*	string	Route id, e.g. 'abc' or 'routes/abc'.

Input schema (JSON)

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

spoke_get_stop

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}.

read-only

Argument	Type	Description
plan_id*	string
stop_id*	string	Stop id, e.g. 'xyz' or 'plans/abc/stops/xyz'.

Input schema (JSON)

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

spoke_get_unassigned_stop

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

read-only

Argument	Type	Description
unassigned_stop_id*	string	Id, e.g. 'abc' or 'unassignedStops/abc'.

Input schema (JSON)

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

spoke_import_stops

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.

Argument	Type	Description
stops*	array
plan_id*	string

Input schema (JSON)

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

spoke_list_custom_stop_properties

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.

read-only

No arguments.

Input schema (JSON)

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

spoke_list_depots

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

read-only

Argument	Type	Description
page_token	string	Page token: pass the previous reply's nextPageToken (with the same other arguments) for the next page.
max_page_size	integer	Results per page, 1-20 (default 20).

Input schema (JSON)

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

spoke_list_drivers

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

read-only

Argument	Type	Description
active	boolean	Only active (true) or inactive (false) drivers.
page_token	string	Page token: pass the previous reply's nextPageToken (with the same other arguments) for the next page.
max_page_size	integer	Results per page, 1-50 (default 50).

Input schema (JSON)

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

spoke_list_operations

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

read-only

Argument	Type	Description
page_token	string	Page token: pass the previous reply's nextPageToken (with the same other arguments) for the next page.
max_page_size	integer	Results per page, 1-20 (default 20).

Input schema (JSON)

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

spoke_list_plan_stops

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.

read-only

Argument	Type	Description
plan_id*	string
page_token	string	Page token: pass the previous reply's nextPageToken (with the same other arguments) for the next page.
max_page_size	integer	Results per page, 1-10 (default 10).
recipient_external_id	string	Only stops whose recipient has this external id.

Input schema (JSON)

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

spoke_list_plans

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.

read-only

Argument	Type	Description
title	string	Only plans with this title.
filter	object	Extra filter fields as documented by Spoke (name -> value), e.g. {"startsGte":"2026-10-01"}.
page_token	string	Page token: pass the previous reply's nextPageToken (with the same other arguments) for the next page.
max_page_size	integer	Results per page, 1-20 (default 10).
starts_on_or_after	string	Only plans starting on or after this date (yyyy-mm-dd).

Input schema (JSON)

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

spoke_list_route_stops

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.

read-only

Argument	Type	Description
route_id*	string
page_token	string	Page token: pass the previous reply's nextPageToken (with the same other arguments) for the next page.
max_page_size	integer	Results per page, 1-10 (default 10).
recipient_external_id	string	Only stops whose recipient has this external id.

Input schema (JSON)

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

spoke_list_routes

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

read-only

Argument	Type	Description
page_token	string	Page token: pass the previous reply's nextPageToken (with the same other arguments) for the next page.
max_page_size	integer	Results per page, 1-20 (default 20).
starts_on_or_after	string	Only routes of plans starting on or after this date (yyyy-mm-dd).

Input schema (JSON)

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

spoke_list_unassigned_stops

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.

read-only

Argument	Type	Description
page_token	string	Page token: pass the previous reply's nextPageToken (with the same other arguments) for the next page.
max_page_size	integer	Results per page, 1-20 (default 20).

Input schema (JSON)

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

spoke_optimize_plan

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.

destructive

Argument	Type	Description
plan_id*	string

Input schema (JSON)

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

spoke_search_stops

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.

read-only

Argument	Type	Description
filter	string	Spoke filter expression, e.g. createdAt >= "2026-10-01T00:00:00Z" and address ~= "London".
keyword	string	Fuzzy full-text keywords.
page_token	string	Page token: pass the previous reply's nextPageToken (with the same other arguments) for the next page.
sort_field	string
sort_order	string
max_page_size	integer	Results per page, 1-20 (default 20).

Input schema (JSON)

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

spoke_update_plan

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}.

destructive

Argument	Type	Description
title	string
plan_id*	string
depot_id	string
starts_on	string
driver_ids	array	The complete new driver list (replaces the old one).

Input schema (JSON)

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