Getting Started with Documentation
Our Developers have also crafted detailed guides to help you get the most use out of the API and, for those of you already using the API with Classic, have the smoothest possible experience transitioning to the Nexus API.
All of our documentation lives here. You can find a guide to conceptual documentation such as authentication, pagination, errors, permissions, search, and more here.
Our complete API Reference guide including every endpoint, parameter, and response shape can be found here.
Migrating from Classic API to the Nexus API
If you were previously on Classic and you need to move your API calls from the Classic API to the new and improved Nexus API, you can find our migration guide with mapping and notes here.
Using Our API with AI Tools
Brand new to the Nexus API we now have instructions for using the MCP server exposing ProWorkflow resources as tools for AI assistants. You can find instructions for using that here.
Options for Authentication
We’ve also introduced a new way to authenticate – while you can still use your API key (which you can find in your Client Area), you can also contact Support to set up JWT Bearer Tokens: pass a JWT in the Authorization header. This gives you user-level access — permissions, division scope, and sensitive field visibility all apply based on the user's settings.
* Requires an OAuth app with a client secret. Contact support@proworkflow.com to get set up.
API Key vs JWT
API Key — account-level access, bypasses all permission checks, all sensitive fields visible, all divisions accessible.
JWT — user-level access, respects user permissions, may hide sensitive fields, scoped to the user's division.