Skip to main content

How to Use the Nexus API

How to make API connections to Nexus? What are the API Endpoints for Nexus? How to set up an MCP connection to Nexus?

V
Written by Vishal Nath

The Nexus API gives you programmatic access to the same data and actions that power ProWorkflow. Use it to sync data with other tools, automate workflows, build dashboards, or connect AI assistants like Claude.

Getting Started with Documentation

  • Developer docs: all of our documentation lives here.

  • Guides: authentication, pagination, errors, permissions and search are covered in the conceptual guides.

  • API Reference: every endpoint, parameter and response shape is in the API Reference.

Migrating from Classic API to the Nexus API

If you were previously on Classic and need to move your API calls to the Nexus API, our migration guide maps Classic API calls to Nexus, with notes.

Choose How to Authenticate

There are two ways to connect. Pick the one that matches what you're building.

API key: account-level access. It bypasses permission checks, shows all sensitive fields and reaches every division. Best for server-to-server integrations and automations. Find it in your Client Area and send it in an apikey header.

OAuth client (JWT Bearer tokens): user-level access. Each person signs in as themselves, and their role, division access and field visibility all apply. Best for apps people sign in to, such as a Claude connector. Any super user can set it up in Settings → Automation → OAuth Clients.

Set Up an OAuth Client

You can create an OAuth client yourself in ProWorkflow. There's no need to contact Support.

Before you start: you need to be a super user. Each account can have one OAuth client.

  1. Go to Settings, then under Automation select OAuth Clients.

  2. Click Set up OAuth client.

  3. Under Redirect URIs, enter the URL your application returns users to after they approve access. Connecting Claude? Keep the prefilled callback: https://claude.ai/api/mcp/auth_callback. Building your own app? Replace it with your app's callback URL, and click Add redirect URI to add more.

  4. Optionally add a Description so your team knows what the client is for, e.g. "Claude connector for our support team".

  5. Click Create client.

  6. In the OAuth client created window, use the copy buttons to copy your Client ID and Client Secret. Store them somewhere secure, such as a password manager, then click Done.

The Set up OAuth client window. For a Claude connector, keep the prefilled callback.

Your Client ID and Client Secret appear once your client is created.

Important: the Client Secret is only shown once. ProWorkflow keeps only a hashed copy, so it can't show it again. If you lose it, rotate the secret to generate a new one, then update your app.

Connect ProWorkflow to Claude

Once your OAuth client is set up, each person on your team can connect Claude to ProWorkflow as themselves:

  1. In Claude, go to Settings → Connectors and choose Add custom connector.

  2. Enter a name (e.g. ProWorkflow) and the MCP server URL: https://api.proworkflow.com/api/v4/mcp

  3. Open Advanced settings and paste your Client ID and Client Secret.

  4. Click Add, then Connect. Sign in to ProWorkflow and approve access.

Claude can then see and do only what that user can see and do in ProWorkflow.

Manage Your OAuth Client

Your client is listed on the OAuth Clients page with its Name, Client ID, Redirect URIs and Created date.

  • Edit redirect URIs: click the pencil icon. The redirect URI your app sends must exactly match one registered on the client, including https:// and any trailing slash.

  • Lost the secret? Click the rotate icon next to your client. The old secret stops working, so update any apps using it.

  • Need to start over? Delete the existing client, then create a new one. Anyone connected through the old client will need to reconnect.

Using Our API with AI Tools (MCP)

The Nexus API includes an MCP server that exposes ProWorkflow resources as tools for AI assistants. It accepts either an API key or an OAuth (JWT) token. You can find setup instructions here.

Troubleshooting

  • "redirect_uri mismatch" error: the URL in your app doesn't exactly match a registered redirect URI. Check spelling, protocol and trailing slashes.

  • I can't see OAuth Clients in Settings: only super users can manage OAuth clients. Ask a super user on your account.

  • The "Set up OAuth client" button is missing: your account already has a client. Use the existing one, or delete it and create a new one.

Still stuck? Contact support@proworkflow.com.

Did this answer your question?