GET /api/v1/connectors
POST /api/v1/flows
GET /api/v1/events?status=completed&limit=50
GET /api/v1/nexus/orders/ORD-8829
// Trace ID: TRX-99281-AX | Latency: 142ms | Status: 200 OK
Tenant-aware architecture
Multi-tenant by design. Isolate data, flows, and connectors per tenant for embedded and white-label deployments.
Headless integration capabilities
Run integration operations entirely through the API without touching the APIWORX UI.
White-label readiness
Embed APIWORX capabilities into your own product under your brand.
Full CRUD platform access
Create, read, update, and delete connectors, flows, events, jobs, and APIXX records programmatically.
OpenAPI & SDK-ready
Documented API with OpenAPI spec, ready for SDK generation and developer tooling.
Embedded use cases
Build integration experiences into SaaS products, portals, and operational tools.
What you can build with the APIWORX API
APIWORX exposes the entire integration platform — connectors, flows, events, jobs, and the APIXX canonical data layer — via a single REST API. Developers use it to build embedded integration experiences, vendor and customer portals, internal operational tools, and headless integration capability for SaaS products.
Embedded integration UX
Embed APIWORX connector setup, flow configuration, and monitoring directly in your SaaS product so customers never leave your app.
White-label integration platform
Run APIWORX under your own brand. Tenant-aware multi-tenant architecture isolates data and flows per customer.
Vendor and customer portals
Build B2B portals on top of the APIXX canonical data model — order status, inventory, document exchange — in days, not months.
Headless operational tooling
Drive flows, events, and APIXX records programmatically without touching the APIWORX UI. Useful for batch processes, internal automation, and scripted operations.
Webhook fan-out
Subscribe to APIXX events and react in your own services — order placed, shipment exception, inventory low — across every connected system through one event stream.
Custom connectors via SDK
Build custom connectors against APIWORX's connector SDK to extend the platform for your own systems or partners' systems.
Developer FAQ
Is the APIWORX API REST or GraphQL?
REST. The API is documented with an OpenAPI 3 specification, which makes SDK generation, Postman import, and API client tooling trivial. A GraphQL gateway is on the roadmap for read-heavy use cases.
How does authentication work?
OAuth 2.0 client credentials for server-to-server access, with scoped API keys for service accounts. Tenant context is enforced on every request so multi-tenant deployments are safe by default.
Can I build a SaaS product on top of APIWORX?
Yes — that's exactly what the platform is designed for. APIWORX powers embedded integration capability for ISVs, white-label deployments for VARs, and headless integration use cases inside SaaS products. Tenant isolation, white-labeling, and per-tenant flows are first-class features.
Are there rate limits?
Yes — generous defaults for production tenants, with the ability to increase limits for high-volume use cases. Rate limit headers are returned on every response so clients can self-pace correctly.
Where are the API docs?
Live API documentation is available at the developer portal. The OpenAPI spec is also downloadable for SDK generation in any major language.