List plans
list_plansRetrieve delivery plans by exact title or start-date range, with drivers and routes, and optionally reveal redacted contact details.
Instructions
Plans (one per working day, each with its drivers and routes) in the order the API returns them. Filter by an exact title and/or a start-date range. Plan titles are free text: email addresses and phone numbers in them are redacted unless include_contact_details is true.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | No | Exact plan title (the API's filter.title; no partial match) | |
| starts_to | No | Plans starting on or before this date, YYYY-MM-DD (filter.startsLte) | |
| page_token | No | next_page_token from a previous call, to continue the same list | |
| max_results | No | Minimum number of records to return; whole pages are returned, so a few more may come back | |
| starts_from | No | Plans starting on or after this date, YYYY-MM-DD (filter.startsGte) | |
| include_contact_details | No | Include email addresses and phone numbers typed into plan titles and route override addresses |