Fleet Platform API
Welcome to the Fleet Platform API documentation.
Guides vs API reference
Section titled “Guides vs API reference”- Guides explain concepts and workflows: auth, resources, and how entities relate.
- API reference is generated from OpenAPI and is the source of truth for exact paths, parameters, bodies, response fields, and operation-specific errors.
Quick orientation
Section titled “Quick orientation”| Topic | Summary |
|---|---|
| Base URL | https://api.fleet.co/platform/v1 in production, https://demo-api.fleet.co/platform/v1 in the sandbox. |
| Auth | Authorization: Bearer <platform_api_secret> on every request. |
| Your data | The key belongs to your Fleet company; every list and change applies to that company. |
| READ vs WRITE | READ keys call every GET; POST, PATCH, and DELETE need WRITE. |
| Rate limits | Per credential, per minute. See Authentication & scopes. |
Where to start
Section titled “Where to start”- Installation — getting a key, the base URLs, and the hosted OpenAPI schema.
- Authentication & scopes — Bearer usage, scopes, and rate limiting.
- Requests & responses — JSON payloads, pagination, and errors.
- Resource guides: Catalog, Carts & orders, Devices, Repairs & storage, Users, Addresses, Company & tickets.
- API reference in the sidebar for exact request/response schemas.
- Skills & AI — copying pages into assistants and installing Platform API skills with
npx skills add.

