Documentation/ API/ Reference

API Reference

Complete reference documentation for all Organiko.ai API endpoints

🔐 Authentication

Manage user authentication and tokens.

POST/auth/login

Authenticate with email and password

POST/auth/refresh

Refresh access token using refresh token

POST/auth/logout

Invalidate current tokens

GET/auth/verify

Verify token validity

POST/auth/forgot-password

Request password reset email

POST/auth/reset-password

Reset password with token

View Detailed Authentication Docs →

💳 Subscriptions

Manage subscriptions, usage, and billing.

GET/subscriptions/current

Get current subscription details

GET/subscriptions/usage

Get usage metrics and limits

POST/subscriptions/upgrade

Upgrade or downgrade subscription tier

POST/subscriptions/cancel

Cancel subscription (effective at period end)

GET/subscriptions/invoices

List all invoices

GET/subscriptions/invoices/:id

Get specific invoice details

GET/subscriptions/payment-methods

List saved payment methods

View Detailed Subscription Docs →

📦 Inventory

Manage products, batches, and inventory levels.

GET/inventory

List all inventory items with filters

POST/inventory/products

Create new product

GET/inventory/products/:id

Get product details

PUT/inventory/products/:id

Update product information

GET/inventory/batches

List all batches

POST/inventory/batches

Create new batch

GET/inventory/batches/:id

Get batch details

🛒 Orders

Manage purchase orders, sales orders, and reconciliation.

GET/orders/purchase

List purchase orders

POST/orders/purchase

Create purchase order

GET/orders/purchase/:id

Get purchase order details

GET/orders/sales

List sales orders

POST/orders/sales

Create sales order

GET/orders/sales/:id

Get sales order details

POST/orders/reconcile

Reconcile purchase order with inventory

📊 Reports

Generate compliance reports and analytics.

GET/reports/mass-balance

Generate mass balance report

GET/reports/traceback

Generate traceback report

GET/reports/compliance

Generate USDA compliance report

GET/reports/audit-log

Get audit log entries

👥 Users

Manage user accounts and permissions.

GET/users/me

Get current user profile

PUT/users/me

Update current user profile

GET/users

List all users in organization

POST/users

Create new user

DELETE/users/:id

Delete user

🔌 Integrations

Manage third-party integrations.

GET/integrations

List all connected integrations

POST/integrations/:provider/connect

Initiate OAuth connection to provider

DELETE/integrations/:id

Disconnect integration

POST/integrations/:id/sync

Trigger manual sync

🔔 Webhooks

Manage webhook subscriptions.

GET/webhooks

List all webhook endpoints

POST/webhooks

Create webhook endpoint

DELETE/webhooks/:id

Delete webhook endpoint

GET/webhooks/:id/deliveries

View webhook delivery history

View Detailed Webhook Docs →

Common Query Parameters

Many list endpoints support these common parameters:

ParameterTypeDescription
limitnumberNumber of results (default: 20, max: 100)
offsetnumberSkip number of results for pagination
sortstringField to sort by (prefix with - for descending)
filterstringFilter expression (e.g., status:active)

HTTP Status Codes

CodeDescription
200Success
201Created
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing authentication
403Forbidden - Insufficient permissions
404Not Found - Resource doesn't exist
429Too Many Requests - Rate limit exceeded
500Server Error - Something went wrong