Get a planning config

GET /v1/planning_configs/{id}

Authentication

Send a token issued in the Zoopit dashboard as Authorization: Bearer <token>.

Path parameters

Name	Type	Required
id	string	yes

Query parameters

Name	Type	Required
select	array of "attributes" | "auto_save_routes" | "created_at" | "created_by" | "deleted_at" | "deleted_by" | "id" | "ignore_capacity" | "ignore_delivery_window" | "ignore_driver_shifts" | "ignore_pickup_window" | "ignore_skills" | "ignore_sorting" | "modified_at" | "modified_by" | "name" | "objectives" | "owners" | "sort_by" | "sort_type" | "tags" | "with_traffic_eta"

Responses

200

resource: PartialPlanningConfigWithId

Field	Type	Required
attributes	object
name	string
created_at	string
modified_at	null or string
deleted_at	null or string
created_by	string
modified_by	null or string
deleted_by	null or string
owners	array of string
tags	array of string
with_traffic_eta	boolean
auto_save_routes	boolean
objectives	array of Objective
sort_type	"delivery" | "pickup" or null
sort_by	null or string
ignore_sorting	null or boolean
ignore_skills	null or boolean
ignore_capacity	null or boolean
ignore_driver_shifts	null or boolean
ignore_pickup_window	null or boolean
ignore_delivery_window	null or boolean
id	string	yes

Example

curl -X GET 'https://routes-api.cloud.zoopit.no/v1/planning_configs/{id}'
  -H 'Authorization: Bearer <token>'

Try it in the interactive Routes API reference.

Field descriptions, guides and worked examples are in the full reference, available to customers in the Zoopit dashboard under Accounts → Developer.