SynthesQDocumentation
API reference, guides, and tutorials for the SynthesQ CRM/ERP platform
Skip to content
Documentation Sections
Getting Started
New to the API? Start here to learn authentication, request patterns, and core concepts.
- Authentication - Bearer token authentication with Laravel Sanctum
- Tenant Management - Multi-tenancy and superuser invitation flow
- Making Requests - Request structure and response formats
- Sparse Fieldsets - Optimize API responses by selecting specific fields
- Error Handling - Understanding error responses and status codes
Operations Module Guides
Learn how to work with products, inventory, and purchase orders.
Product Management
- Product Lifecycle - Product statuses and state transitions
- Inventory Management - Stock tracking and adjustments
- Product Variants - Managing product variations
- Product Attributes - Custom attributes and metadata
Inventory & Warehouses
- Stock Movements - Tracking inventory changes
- Warehouse Transfers - Moving stock between warehouses
- Physical Counts - Inventory reconciliation
Purchase Orders
- PO Workflow - Purchase order lifecycle
- Receiving Goods - Recording incoming inventory
- Auto-Reordering - Automated reorder points
API Reference
Complete endpoint documentation auto-generated from code.
The API reference includes:
- All available endpoints organized by module
- Request parameters and validation rules
- Response schemas and field descriptions
- Example requests and responses
Quick Example
bash
# Authenticate
curl -X POST https://api.synthesq.com/api/v1/auth/login \
-H "Content-Type: application/json" \
-d '{"email": "user@example.com", "password": "password"}'
# Fetch products with specific fields
curl https://api.synthesq.com/api/v1/operations/products \
-H "Authorization: Bearer YOUR_TOKEN" \
-G -d "fields[products]=id,name,sku,selling_price,stock_quantity"Available Modules
Documentation is currently available for:
- Operations - Products, inventory, purchase orders, suppliers, warehouses
- CRM - (Coming soon)
- Sales - (Coming soon)
- Finance - (Coming soon)
- HRM - (Coming soon)
- Analytics - (Coming soon)