ERPnBox REST API
A complete, metadata-driven REST API for building integrations on top of your ERPnBox instance. Read and write any module, search across your data, run aggregate queries, and subscribe to real-time webhooks — all secured with scoped API keys and isolated per tenant.
Base URL
https://api.erpnbox.com/api/v1All endpoints are versioned under /api/v1. Every request is authenticated with an API key and scoped automatically to the tenant that owns the key — you never pass a tenant ID.
What you can build
| Capability | Use case |
|---|---|
| Two-way data sync | Mirror Leads, Deals, Contacts or any custom module into another system |
| Lead capture | Push form, ad, or website submissions straight into a CRM module |
| Reporting & BI | Pull aggregates into Power BI, Looker, Metabase, or a data warehouse |
| Real-time automation | Trigger external workflows the moment a record is created or updated |
| Migrations & backfills | Bulk-load or export records during onboarding |
Design principles
- Metadata-driven. There are no hardcoded objects. Every module (Leads, Deals, custom entities) and every field is discoverable at runtime via the Modules API — your integration adapts automatically as the admin adds fields.
- Consistent envelopes. Every response is
{ success, data }or{ success, error }. List endpoints add ametablock with pagination. - Tenant-isolated by construction. Keys carry their tenant; cross-tenant access is impossible.
- Least-privilege. Scopes restrict each key to exactly the operations it needs.
Interactive reference
An auto-generated OpenAPI 3.0 specification and a live “try it” console are served directly from your instance:
| Resource | URL |
|---|---|
| Swagger UI | https://api.erpnbox.com/api-docs |
| OpenAPI JSON | https://api.erpnbox.com/api-docs.json |
Endpoint map
GET
/modulesList all modulesGET
/modules/:apiNameModule details + fieldsGET
/modules/:apiName/fieldsField metadata onlyGET
/records/:moduleList / filter recordsGET
/records/:module/:idGet a single recordPOST
/records/:moduleCreate a recordPUT
/records/:module/:idUpdate a recordDELETE
/records/:module/:idDelete a recordGET
/searchSearch within a modulePOST
/analytics/aggregateRun an aggregate queryGET
/usersList usersGET
/users/:idGet a userGET
/webhooksList webhooksPOST
/webhooksCreate a webhookPUT
/webhooks/:idUpdate a webhookDELETE
/webhooks/:idDelete a webhookGET
/webhooks/:id/deliveriesView delivery logsERPnBox API v1 — Need help? Contact support@erpnbox.com