Skip to content
Fleet Fleet beta

Requests & responses

URL layout

Section titled “URL layout”

All platform endpoints share the path prefix /platform/v1. Combine it with your host (for example https://api.fleet.co) to build full URLs.

Path IDs

Section titled “Path IDs”

Path identifiers (order_id, user_id, device_id, product_id, product_group_id, …) are strings matching a positive integer with no leading zeros (for example 42, not 042).

Pagination

Section titled “Pagination”

List operations accept limit and offset. Defaults and max values vary by resource.
The response meta object repeats total, limit, and offset.

Success payloads

Section titled “Success payloads”
  • Single resource: top-level data is one object.
  • List: data is an array and meta carries pagination fields.
  • Batch device create: data wraps a devices array; the status code is 201.

For exact field names and nested objects, use the API reference.

Errors

Section titled “Errors”
  • Domain / business rules: usually { "error": "SOME_CODE" } with stable codes (for example ORDER_NOT_FOUND, INSUFFICIENT_SCOPE, USER_EMAIL_CONFLICT).
  • Validation: typically 400 with { "error": "<readable message>" } when query or body does not match schema.

JSON bodies

Section titled “JSON bodies”

For POST and PATCH, send Content-Type: application/json, unless an operation says otherwise.

Throughput

Section titled “Throughput”

Platform routes are rate-limited per credential (see Authentication & scopes for production vs non-production limits and 429 / 503 behavior).