Fleet Platform API

Welcome to the Fleet Platform API documentation.

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.

Swagger and OpenAPI on the API host

• Swagger UI: https://api.fleet.co/platform/v1/swagger
• OpenAPI JSON: https://api.fleet.co/platform/v1/openapi.json
• Sandbox / demo API: same paths on https://demo-api.fleet.co
• Use this docs site for narrative guides; use Swagger/OpenAPI when your tooling needs a hosted schema or interactive request explorer.

Quick orientation

Topic	Summary
Base URL	Production: https://api.fleet.co. All routes use the prefix /platform/v1.
Auth	Send Authorization: Bearer <platform_api_secret> on every request.
Your data	The key is tied to your Fleet workspace; lists and updates always apply to your catalog, people, devices, and orders.
READ vs WRITE	Keys are READ (query only) or WRITE (can create and change carts, users, devices, and validate carts). Mutations without WRITE return INSUFFICIENT_SCOPE.
Rate limits	Production: up to 100 requests/minute per credential. Sandbox: up to 300 requests/minute per credential. Uses a 1-minute window and may return RateLimit-* headers. If the limiter backend is unavailable, API may return 503.

Where to start

1. Installation — getting a key and trying the API safely.
2. Authentication & scopes — Bearer usage, scopes, and rate limiting.
3. Requests & responses — how JSON payloads and list pagination are shaped.
4. Resource guides: Catalog, Carts & orders, Devices, Users.
5. API reference in the sidebar for exact request/response schemas.
6. Skills & AI — copying pages into assistants and installing Platform API skills with npx skills add.