Get a plan
get_planRetrieve a dispatch plan by ID to view its start date, depot, optimization and distribution status, drivers, routes, and overrides. Set include_contact_details to also return emails and phone numbers.
Instructions
One plan: start date, depot, optimization and distribution state, driver IDs, route IDs and route overrides.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"plan_id": "<plan_id>"
},
"name": "get_plan"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan_id | Yes | Plan ID (plans/<id> or the bare <id>) | |
| include_contact_details | No | Include email addresses and phone numbers typed into the title and route override addresses |