REST API v2

Build against the Fiddle REST API

Read and write Fiddle data with plain HTTPS requests. Use the HTTP client you already trust, send JSON, and authenticate with an API key from your Fiddle account.

Open API docsGet an API key
REST JSON
Auth
Bearer token
Format
application/json
Base
v2
curl "https://fiddle.io/rest/api/v2/items?limit=50" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

# Create a sales order
curl -X POST "https://fiddle.io/rest/api/v2/sales-orders" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": "CUSTOMER_ID",
    "lineItems": [
      { "itemId": "ITEM_ID", "quantity": 2 }
    ]
  }'
Base URL
https://fiddle.io/rest/api/v2
Authentication
Authorization: Bearer YOUR_API_KEY
Documentation
Redoc and Swagger UI

No package install required

Use any standard HTTP client

Fiddle exposes a REST API, not a set of official language packages. Your integration can run from a server, worker, script, automation platform, or internal app as long as it can send authenticated HTTPS requests.

JavaScript fetch
Python urllib
Ruby Net::HTTP
PHP cURL
Go net/http
.NET HttpClient

What the API is for

Connect Fiddle to the systems your team already runs

The API is scoped to the same account data users can access in the app, so custom integrations can work with inventory, orders, stock movement, and operational events without inventing a separate data model.

Inventory sync

Read items, locations, and stock levels so external systems stay aligned with Fiddle.

Order workflows

Create and fetch sales orders for custom storefronts, operations tools, and channel bridges.

Stock adjustments

Post controlled adjustments for damaged goods, cycle counts, receiving fixes, and transfers.

Webhook reactions

Subscribe an HTTPS endpoint to Fiddle events and fetch full records through the API.

Build path

A practical start for custom integrations

Start narrow, verify against your own Fiddle data, then expand the integration after the request and error handling are boring in the best possible way.

01

Create an API key

Generate a dedicated key from Settings, copy it once, and store it in your secrets manager.

02

Open the live reference

Use Redoc to inspect schemas or Swagger UI to test requests while shaping your payloads.

03

Make a first request

Send JSON over HTTPS with your bearer token. Start with a read-only endpoint before writing.

04

Add webhooks if needed

For real-time workflows, receive event notifications and use the API to fetch current data.

Documentation

Real references, examples, and setup guides

Developer help center

Readable API reference

Browse the generated REST reference for endpoints, fields, request bodies, and response shapes.

Open

Swagger UI

Try requests against the live schema while you are building and validating payloads.

Open

REST API overview

Understand the base URL, JSON request format, account scoping, and first request.

Open

Get an API key

Create a key in Fiddle and send it as a bearer token on every server-side request.

Open

Auth and rate limits

Review authentication errors, request limits, retry behavior, and secure key handling.

Open

Common API recipes

Copy curl examples for listing items, fetching records, creating orders, and adjusting stock.

Open

Need a hand?

Bring us the workflow you are connecting

If you are mapping a custom storefront, warehouse tool, reporting pipeline, or ERP bridge, we can help you choose the right endpoints and rollout plan.

Contact supportBrowse built-in integrations