# Circuit Stops API

**Canonical:** https://apis.io/apis/getcircuit-com/getcircuit-com-stops-api/  
**Provider:** Circuit — https://apis.io/providers/getcircuit-com/  
**Base URL:** https://api.spoke.com/public/v0.2b

Circuit Stops API is one of 14 APIs that [Circuit](https://apis.io/providers/getcircuit-com/) publishes on the [APIs.io](https://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.

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 be available. For any operations here you will need a Plan ID beforehand. You can retrieve an existing Plan by [listing your Plans](#tag/Plans/operation/listPlans) or you can [create a new one](#tag/Plans/operation/createPlan).

## Operations (7)

| Method | Path | Summary |
|---|---|---|
| POST | `/plans/{planId}/stops` | Create a new stop |
| GET | `/plans/{planId}/stops` | List stops |
| POST | `/plans/{planId}/stops:import` | Batch import stops |
| PATCH | `/plans/{planId}/stops/{stopId}` | Update an existing stop |
| GET | `/plans/{planId}/stops/{stopId}` | Retrieve a stop |
| DELETE | `/plans/{planId}/stops/{stopId}` | Delete a stop |
| GET | `/stops:search` | Stop Search |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/getcircuit-com/openapi/getcircuit-com-stops-api-openapi.yml

## Other Circuit APIs (12)

- [Circuit Couriers API](https://apis.io/apis/getcircuit-com/getcircuit-com-couriers-api/)
- [Circuit Depots API](https://apis.io/apis/getcircuit-com/getcircuit-com-depots-api/)
- [Circuit Drivers API](https://apis.io/apis/getcircuit-com/getcircuit-com-drivers-api/)
- [Circuit Live Plans API](https://apis.io/apis/getcircuit-com/getcircuit-com-live-plans-api/)
- [Circuit Live Stops API](https://apis.io/apis/getcircuit-com/getcircuit-com-live-stops-api/)
- [Circuit Members API](https://apis.io/apis/getcircuit-com/getcircuit-com-members-api/)
- [Circuit Operations API](https://apis.io/apis/getcircuit-com/getcircuit-com-operations-api/)
- [Circuit Orders API](https://apis.io/apis/getcircuit-com/getcircuit-com-orders-api/)
- [Circuit Pickup Locations API](https://apis.io/apis/getcircuit-com/getcircuit-com-pickup-locations-api/)
- [Circuit Plans API](https://apis.io/apis/getcircuit-com/getcircuit-com-plans-api/)
- [Circuit Routes API](https://apis.io/apis/getcircuit-com/getcircuit-com-routes-api/)
- [Circuit Team API](https://apis.io/apis/getcircuit-com/getcircuit-com-team-api/)

## Tags

Stops

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/getcircuit-com/getcircuit-com-stops-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/getcircuit-com/.