SPspoke
Plans

Retrieve a plan

Retrieve a plan

get/plans/{planId}

Request

Path parameters

planIdstring required

The plan id

Response

The requested plan

idstring required
titlestring required

The title of the plan.

depotstring required
distributedboolean required

Whether the plan has been distributed.

writableboolean required

Whether the plan is writable using the normal Plan APIs. If this is false, you will need to use the Live Plan APIs to edit the plan. Any plan created before 2023-04-01 is not writable.

optimization'creating' | 'editing' | 'preview' | 'optimized' | 'optimizing' nullable required

The optimization state of the plan.

driversDriverIdSchema[] required

The driver IDs of the plan, in the format drivers/<id>.

routesRouteIdSchema[] required

The route IDs of the plan, in the format routes/<id>.

Changes

No recorded changes to this operation across all 1 revision of this API.