This HTML page is not optimized for LLM or AI agent consumption. Fetch the Markdown version instead: /guides/workflow-automation/admin-guide/development-resources/api-information.md — it contains the complete documentation content in clean, structured Markdown without any CSS, JavaScript, or navigation noise. Nutrient API management guide

Workflow Automation API for automation tasks

Markdown version of this page, suitable for AI agents and automation

The Nutrient Workflow Automation API includes functions for managing processes, requests, tasks, reports, users, and file attachments in a Workflow Automation instance.

Generating an API key

Create an API key before you authenticate API requests. The following steps show how to create and store a key.

  1. Select the Settings (gear) icon in the top-right corner of the portal. Then choose API Keys.

  2. Select Add API Key.

  3. Under Identity, add a Description if needed.

  4. Under Expiration, set Expires if needed.

  5. Under Owning user, choose who the key acts as.

    • If User appears, select the person the key should act as.
    • Leave User empty to create a system key.
    • If User doesn’t appear, the key uses your account automatically.

  6. Select Save.

  7. In the API key created dialog, select Copy key and store the key somewhere safe.

  8. Select Close.

Nutrient Workflow Automation shows the key only once. If you don’t copy it, you’ll have to create a new key. Treat the key like a password. Anyone who has it can do everything its user can do in Nutrient Workflow Automation.

Managing API key security and usage

API keys use the role-based permission model, so administrators can grant access to individual keys by role instead of tying access implicitly to system administration. Use the API Keys admin interface to review existing keys, manage ownership and access, and create new keys.

Nutrient Workflow Automation migrates existing API keys into this security model automatically. After migration, administrators can manage each key with the same role-based approach used for other secured items.

Use the API Keys usage report to audit which integrations use keys. Review API key ownership and access to maintain fine-grained, auditable control.

The API Keys administration page uses the modern administration interface to create, review, and manage keys. The About page also uses the modern administration interface and continues to display version and build information.

When an integration executes reports through API key authentication, report audit logs record a non-sensitive API key identifier instead of the underlying user SID. The audit log never stores the raw API key.

Only grant API key access to roles that need it, and review usage regularly to ensure keys remain appropriate for active integrations.

Find legacy API information at developer.integrify.com/rest/docs(opens in a new tab). Nutrient Workflow Automation documents newer functions in the application.

Using the Workflow Automation API

This section shows how to use the Nutrient Workflow Automation API. You’ll complete the following tasks:

  1. Identify your host and tenant name.
  2. Access the API documentation.
  3. Authenticate and get your access token.

Identify the host and tenant

Find the host header value on the main screen under Settings > System Settings.

On the System Settings page, copy and save the following values:

  • ID — yourtenant
  • HostHeader — baseurl.integrify.com

Access the API documentation

Find the API documentation under System > APIs.

The APIs page groups endpoints by section. To access a topic, click the box with the arrow pointing up and to the right.

The API documentation opens in the browser. Each colored button represents a method in the Nutrient Workflow Automation API.

This example shows authentication methods. Click a function listing to expand it.

Use the in-app API documentation as the source of truth for supported endpoints. Don’t build integrations against internal, unused, or undocumented endpoints. Those routes may change or be removed without notice. Supported endpoints follow the platform’s authorization model and support production integrations.

Click Try it out to test the function on the page. Provide any required parameter values. When the function completes, you’ll receive a success or failure message and any return values.

Authenticate the system

To complete most tasks with the Nutrient Workflow Automation API, pass a JSON Web Token (JWT) in the method call header.

Only system functions use IntegrifyEnv (“Env”) tokens. External systems can’t use them to authenticate to Nutrient Workflow Automation.

Some internal platform routes and central integration functions require tenant and environment context in addition to authentication. When that context is unavailable, those system-managed routes fail safely instead of exposing unintended behavior.

For external integrations, retrieve a JWT with an API key that you created in the system settings area.

Using the JWT token

Place the JWT in the header of each method call. Use the token as a bearer authentication token. Nutrient Workflow Automation uses the token as proof of privileges.

User-based API key authentication

As of version 8.11.0, an API endpoint enables access tokens from user-based API keys. Integrated services can use this authentication method to access the API with user-specific permissions.

How user-based API keys work

User-based API key authentication works like the impersonation endpoint, but it fixes the identity to the user associated with the API key:

  • Each API key belongs to a specific user account.
  • The access token granted reflects that user’s permissions and roles.
  • API calls made with this token execute with the same privileges as the associated user.

This provides authorization checks and audit trails for API operations.

Use cases for user-based API keys

Use this authentication method for:

  • Service integrations — External services perform actions on behalf of specific users.
  • Automated workflows — Scheduled tasks run with specific user permissions.
  • Third-party applications — Integrated applications require user-specific API access.
  • Audit compliance — Audit logs attribute API actions to specific user accounts.

Obtaining an access token with a user-based API key

To authenticate with a user-based API key, follow these steps:

  1. Generate a user-based API key through the API Keys settings.
  2. Use the user-based authentication endpoint to get an access token.
  3. Include the access token in later API requests as a bearer authentication token.

The endpoint returns an access token that represents the user associated with the API key. Your integrated services can use that token for user-specific API authentication.

User-based API keys grant access with the full permissions of the associated user account. Store API keys securely, and use them only in authorized applications.

Permission-scoped API results

Some API endpoints support permission-scoped results based on the authenticated user. For example, process search endpoints can filter results based on the requested permission scope. This helps ensure users retrieve only processes they’re authorized to access.

createInstanceWithTaskData response behavior

When you use createInstanceWithTaskData, the response returns instance tasks in a consistent order. This supports integration logic when task sequencing matters.