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 Stops API

Endpoints to operate on [Stop](/docs/models/stop) resources.For any [Plans](/docs/models/plan) created before 2023-04-01 the stopcollections and all related operations will not be available.For any operations here you will need a Plan ID beforehand. You can retrieve anexisting Plan by [listing your Plans](#tag/Plans/operation/listPlans) or you can[create a new one](#tag/Plans/operation/createPlan).

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

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

This API exposes 7 operations across 4 paths, and defines 10 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.

7 operations 4 paths 10 schemas 1 DELETE3 GET1 PATCH2 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 Stops 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 7

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

Stops 7

Endpoints to operate on [Stop](/docs/models/stop) resources. For any [Plans](/docs/models/plan) created before 2023-04-01 the stop collections and all related operations will not…

POST
/plans/{planId}/stops
Create a new stop
createStop 1 param body → 200400401403404409410422
GET
/plans/{planId}/stops
List stops
listStops 4 params → 200400401403404500default
POST
/plans/{planId}/stops:import
Batch import stops
importStops 1 param body → 200400401403404409410422
PATCH
/plans/{planId}/stops/{stopId}
Update an existing stop
updateStop 2 params body → 200400401403404409500default
GET
/plans/{planId}/stops/{stopId}
Retrieve a stop
getStop 2 params → 200400401403404500default
DELETE
/plans/{planId}/stops/{stopId}
Delete a stop
deleteStop 2 params → 204400401403404409500default
GET
/stops:search
Stop Search
searchStops 6 params → 200400401500default

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are stopSchema (30 properties), stopSchema_2 (29 properties), unassignedStopSchema (18 properties), routeSchema (6 properties). Each schema is shown below with its type and property counts.

unassignedStopIdSchema
string
stopIdSchema
string
driverIdSchema
string
stopSchema
object
A stop of a plan, can be related to a route.
30 properties 28 required
timeOfDaySchema
object
Time of day in hours and minutes. Uses a 24 hour clock.
2 properties 2 required
unassignedStopSchema
object
An unassigned stop.
18 properties 16 required
stopSchema_2
object
A stop of a plan, can be related to a route.
29 properties 27 required
routeIdSchema
string
planIdSchema
string
routeSchema
object
A route.
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

circuit-stops-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 Plans API
Circuit Routes API
Circuit Team API
Circuit Unassigned Stops API
Where this information came from

This is an independent, third-party profile of Circuit Stops 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.