REST API overview

The Fiddle REST API lets you read and write your inventory, orders, and manufacturing data programmatically — useful for custom integrations, internal tooling, and bulk operations.

Base URL and versioning

All endpoints live under a single versioned base URL:

https://fiddle.io/rest/api/v2

Requests and responses use JSON. Send Content-Type: application/json on any request with a body.

Interactive documentation

Two browsable references are generated from the API’s OpenAPI spec. They list every endpoint with its parameters, request body, and response shape:

Reference	URL
Redoc (readable reference)	https://fiddle.io/rest/api/v2/docs
Swagger UI (try requests live)	https://fiddle.io/rest/api/v2/docs/swagger

A first request

Every call needs your API key in the X-API-Key header. This example lists the first 10 inventory items:

curl "https://fiddle.io/rest/api/v2/inventory-items?size=10" \
  -H "X-API-Key: YOUR_API_KEY"

Resource paths are plural and hyphenated: /inventory-items, /inventory-lots, /sales-orders, /purchase-orders, /customers, and so on.

Response shape

Responses are JSON objects keyed by the resource name. A single record uses the singular name, and a list uses the plural name plus a meta object for paging:

{
  "inventoryItems": [
    { "id": "…", "name": "Lavender Soap 4oz", "sku": "SOAP-LAV-4OZ" }
  ],
  "meta": { "page": 1, "size": 10, "total": 156, "lastPage": 16 }
}

GET /inventory-items/{id} returns { "inventoryItem": { … } }, GET /quotes returns { "quotes": [ … ], "meta": { … } }, and so on.

Each API key acts as the Fiddle user it’s assigned to. The API returns the same data that user sees in the app, scoped to your account.

Next steps

First, get an API key. Then review authentication and rate limits before you build.