How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Circuit Plans API

Endpoints to operate on [Plans](/docs/models/plan) resources.

Circuit Plans API is one of 11 APIs that Circuit publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Plans. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 8 operations across 5 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version v0.2b.

Requests are made against a single base URL, https://api.spoke.com/public/v0.2b.

8 operations 5 paths 13 schemas 1 DELETE3 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v0.2b
Base URL
https://api.spoke.com/public/v1
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Circuit Plans API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • BasicAuth — Use the API key as the username and leave the password empty.

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Plans 8

Endpoints to operate on [Plans](/docs/models/plan) resources.

POST
/plans
Create a new plan
createPlan body → 200400401403404409500default
GET
/plans
List plans
listPlans 3 params → 200400401500default
PATCH
/plans/{planId}
Update an existing plan
updatePlan 1 param body → 200400401403404409default
GET
/plans/{planId}
Retrieve a plan
getPlan 1 param → 200400401403404500default
DELETE
/plans/{planId}
Delete a plan
deletePlan 1 param → 204400401403404500default
POST
/plans/{planId}:optimize
Optimize a plan
optimizePlan 1 param → 200400401403404409500default
POST
/plans/{planId}:distribute
Distribute a plan
distributePlan 1 param → 200400401403404409500default
GET
/plans/{planId}/stops
List plan stops
listPlanStops 4 params → 200400401403404500default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are stopSchema (29 properties), planSchema (9 properties), driverSchema (8 properties), routeSchema (6 properties). Each schema is shown below with its type and property counts.

stopIdSchema
string
depotIdSchema
string
operationIdSchema
string
planSchema
object
A plan.
9 properties 9 required
driverSchema
object
A driver.
8 properties 8 required
driverIdSchema
string
operationSchema
object
5 properties 5 required
stopSchema
object
A stop of a plan, can be related to a route.
29 properties 27 required
routeIdSchema
string
timeOfDaySchema
object
Time of day in hours and minutes. Uses a 24 hour clock.
2 properties 2 required
dateSchema
object
A date.
3 properties 3 required
planIdSchema
string
routeSchema
object
A route.
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

circuit-plans-api-openapi.yml Raw ↑

Other APIs Circuit publishes across the network.

Circuit Depots API
Circuit Drivers API
Circuit Live Plans API
Circuit Live Stops API
Circuit Members API
Circuit Operations API
Circuit Routes API
Circuit Stops API
Circuit Team API
Circuit Unassigned Stops API
Where this information came from

This is an independent, third-party profile of Circuit Plans API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.