This documentation is currently being written. Content will be expanded and refined over time.

API Reference

Complete reference for all Synaptik API endpoints.

Endpoints

The API is organized around REST principles. All endpoints accept and return JSON. Standard HTTP methods are used for CRUD operations.

Sales

  • GET /v1/invoices — List invoices
  • POST /v1/invoices — Create invoice
  • GET /v1/quotes — List quotes
  • POST /v1/quotes — Create quote

Inventory

  • GET /v1/products — List products
  • GET /v1/warehouses — List warehouses
  • GET /v1/stock-levels — Query stock levels

Purchasing

  • GET /v1/purchase-orders — List purchase orders
  • POST /v1/purchase-orders — Create purchase order

Pagination

List endpoints support cursor-based pagination using cursor and limit query parameters. The response includes a next_cursor field when more results are available.

Rate Limits

API requests are limited to 1,000 requests per minute per API key. Rate limit headers are included in every response.