Fleet Platform API

Welcome to the Fleet Platform API documentation.

Guides vs API reference

• Guides explain how the API is organized—resources, ideas behind carts and catalog, authentication, and limits—and point you to the right operations.
• API reference is generated from the OpenAPI document: every path, parameter, body, response field, and operation-specific error. Use it whenever you need exact names, types, or enums.

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 per minute per API credential. Sandbox: up to 300 per minute per credential. Counting uses a 1-minute sliding window; responses may include standard RateLimit-* headers. If Fleet’s rate-limit service is unavailable, you may receive 503 with a short retry message—see Authentication & scopes.

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 concrete request/response schemas.
6. Skills & AI — copying pages into assistants and installing Platform API skills with npx skills add.