Full REST API for every module. Integrate with anything.
Everything you need to integrate with the Yield API.
https://your-domain.com/api/v1/
application/json
All API requests require a Bearer token in the Authorization header, obtained via OAuth.
Authorization: Bearer your_access_token
All responses follow a standard envelope format.
List endpoints return paginated responses with data and meta fields. Single-resource endpoints return the object directly in data.
Standard query parameters available on all list endpoints.
| Parameter | Description | Example |
|---|---|---|
?search= |
Full-text search across relevant fields | ?search=acme |
?sort= |
Sort by field. Prefix with - for descending |
?sort=-createdAt |
?page= |
Page number (default: 1) | ?page=3 |
?pageSize= |
Items per page (default: 25) | ?pageSize=50 |
Every module exposes a consistent set of RESTful endpoints.
/api/v1/partners
/api/v1/partners/:id
/api/v1/products
/api/v1/products/:id
/api/v1/products/categories
/api/v1/crm/leads
/api/v1/crm/leads/:id
/api/v1/crm/leads/:id/convert
/api/v1/sales/orders
/api/v1/sales/orders/:id
/api/v1/sales/orders/:id/confirm
/api/v1/purchasing/orders
/api/v1/purchasing/orders/:id/confirm
/api/v1/inventory/transfers
/api/v1/inventory/stock
/api/v1/inventory/warehouses
/api/v1/accounting/invoices
/api/v1/accounting/payments
/api/v1/accounting/journal-entries
/api/v1/manufacturing/orders
/api/v1/manufacturing/boms
/api/v1/project/projects
/api/v1/project/tasks
/api/v1/events
/api/v1/events/:id/registrations
/api/v1/fleet/vehicles
/api/v1/fleet/fuel-logs
/api/v1/maintenance/requests
/api/v1/maintenance/equipment
/api/v1/repair/orders
/api/v1/repair/orders/:id/confirm
/api/v1/system/health
public
/api/v1/system/modules
/api/v1/audit/logs
/api/v1/audit/logs/:id
/api/v1/audit/entity/:table/:entity_id
Receive real-time notifications when events happen in Yield.
Configure webhooks in your Yield admin panel under Settings > Webhooks. Provide a URL and select the events you want to subscribe to.
partner.created
partner.updated
sale.order.confirmed
sale.order.cancelled
purchase.order.confirmed
invoice.created
payment.received
inventory.transfer.completed
lead.converted
manufacturing.order.completed
Every webhook request includes an X-Yield-Signature header containing an HMAC-SHA256 signature of the request body, signed with your webhook secret.
If your endpoint returns a non-2xx status code or times out, Yield will retry the webhook delivery every 5 minutes for up to 24 hours. After 24 hours of failed attempts, the webhook delivery is marked as failed and can be retried manually from the admin panel.
Yield automatically logs every data change across all modules. Every create, update, delete, and soft-delete is recorded with full before/after snapshots, user attribution, and timestamps.
The audit system captures comprehensive change data for every database operation:
Insert, Update, Delete, or SoftDelete
Which user made the change, linked to ERP user ID
Full JSON of old and new entity state for every change
Exactly which columns were modified in each update
Query audit logs via REST API with filtering by table, event type, user, and entity ID.
The audit trail is automatic and immutable. It covers every module — partners, products, sales, purchasing, inventory, accounting, and more. Ideal for SOC 2, GDPR data access logging, HIPAA audit requirements, and internal investigations. Soft deletes are detected automatically and logged as a distinct event type.
Yield includes a built-in MCP (Model Context Protocol) server. Any AI agent — Claude, GPT, or custom — can discover and interact with your ERP operations through standardized tool interfaces.
MCP exposes two endpoints automatically:
/mcp/sse
Server-Sent Events transport
/mcp/messages
HTTP POST transport
40+ tools organized by module, automatically discoverable by any MCP-compatible AI agent.
search_partners, get_partner, list_customers, list_suppliers, create_partner
search_products, get_product, list_categories, get_inventory_levels
search_leads, get_lead, move_lead_stage, get_pipeline, mark_lead_won/lost
search_orders, get_order, create_order, add_order_line, confirm_order
search_purchase_orders, get_purchase_order, create_purchase_order
get_stock_levels, list_warehouses, get_picking, create_transfer
list_accounts, search_invoices, get_invoice, list_payments
list_projects, get_project, list_tasks, create_task, update_task_stage
get_erp_status, list_modules, list_companies, get_company
Claude connects to your ERP's MCP endpoint to understand live system state before making code changes. It queries your modules, schemas, and data to generate precise, context-aware customizations.
$ claude "show me all products with low stock"
Querying MCP: get_stock_levels...
Found 3 products below reorder point:
Widget A — 5 units (reorder: 25)
Gadget B — 2 units (reorder: 10)
Part C — 0 units (reorder: 50)
Our team can help you build custom integrations, modules, and data migrations.