Supergood | Worldox API
Programmatically access document search, profiling, versions, cabinets, and audit trails from Worldox with a stable REST API. Supergood builds and operates production-grade, unofficial Worldox integrations so your team can automate legal DMS workflows without heavy custom engineering.
Plain English: Worldox is a document management system used by large law firms to organize, secure, version, and find work product (documents, emails, PDFs) using client/matter profiles. It adds check-in/check-out, ethical walls, advanced search, and retention to help attorneys and staff work faster while staying compliant.
For a tech company integrating with Worldox—especially if your customer’s primary DMS is iManage—an unofficial API lets you pull documents, versions, and audit history; push new content with proper client/matter profiles; synchronize metadata; and orchestrate check-in/check-out without requiring desktop plugins. You can build features like a matter-centric overlay that surfaces Worldox and iManage content side-by-side, automated filing from your app into the right cabinet and matter, cross-DMS search, defensible migration utilities, and usage analytics and DLP safeguards that span both systems.
What is Worldox?
Worldox (https://www.worldox.com) is a legal-focused document management platform used by law firms and professional services organizations to classify and secure documents and emails with matter-centric profiles.
Core product areas include:
- Document Capture & Filing (Outlook and desktop integrations, email and attachment capture)
- Profiling & Classification (Client/Matter, Doc Type, Author, custom index fields, cabinets)
- Search & Indexing (Profile search, full-text, saved searches, favorites/workspaces)
- Version Control & Check-In/Check-Out (Locks, major/minor versions, compare)
- Security & Ethical Walls (Users/groups, ACLs, matter-based restrictions)
- Records & Retention (Policies, disposition, legal holds)
- Audit & Reporting (Activity logs, who accessed/edited what and when)
Common data entities:
- Documents (Files and emails with profile metadata, cabinet, pathing)
- Versions (Version number, status, comments, timestamps)
- Cabinets & Profile Groups (Field sets like Client, Matter, Doc Type)
- Index Values (Lists of Clients, Matters, Authors, Doc Types)
- Users/Groups & Security Policies (Access controls, ethical walls)
- Saved Searches & Workspaces (Favorites, matter-centric views)
- Audit Events (Create, edit, move, check-in/out, permission changes)
The Worldox Integration Challenge
Turning a desktop-first DMS into API-driven automation can be tricky:
- Profile variance: Each cabinet can have different field sets and required values (client/matter/doc type), which must be validated server-side
- Check-in/out semantics: Locks, offline edits, and version rules require careful lifecycle handling and conflict resolution
- Hybrid deployments: On-prem Windows networks, AD/SSO, and Worldox Web/Cloud variants complicate headless authentication
- Search nuances: Combining profile filters with full-text queries and saved searches while maintaining relevance and pagination
- Security boundaries: Ethical walls and granular ACLs must be respected when listing, downloading, or filing content
- Large files & emails: Efficient, resumable uploads/downloads and email metadata extraction are essential for scale
How Supergood Creates Worldox APIs
Supergood reverse-engineers authenticated browser and desktop flows to deliver a resilient API endpoint layer for your Worldox environment.
- Handles username/password, Windows/AD-backed SSO/OAuth, and MFA where enabled
- Maintains session continuity with automated refresh and change detection
- Normalizes cabinets, profiles, and document objects so you can integrate once and rely on consistent schemas
- Aligns with customer entitlements, ACLs, and ethical walls to ensure compliant access
- Supports high-volume operations (bulk filing, versioning) with polling or webhooks for long-running jobs
Use Cases
Cross-DMS Overlay For iManage-Centric Teams
- Present a unified, matter-centric view that includes Worldox and iManage items
- Keep client/matter metadata in sync when users file or re-profile documents
- Provide consistent check-in/check-out and versioning behaviors across systems
Matter-Centric Search & Document Bots
- Search Worldox by client/matter, doc type, author, and full-text from your app
- Auto-file generated documents (e.g., PDFs from your workflow) into the correct cabinet with the right profile
- Trigger reminders to check in stale check-outs and reconcile duplicates
Migration & Coexistence (Worldox ↔ iManage)
- Export documents with full profiles and version history for batch migration
- Maintain dual-write filing during phased migrations, with idempotent retries
- Map profile fields (e.g., Client/Matter/Doc Type) to iManage Workspace/Folder taxonomies
Compliance, DLP & Auditing
- Stream audit events to your monitoring or analytics system
- Enforce filing rules (e.g., no external sharing until profiled to a matter)
- Detect anomalous access patterns and auto-adjust security or alert reviewers
Available Endpoints
Authentication
POST /sessions: Establish a session using credentials. Supergood manages AD-backed SSO/OAuth and MFA where enabled. Returns a short-lived auth token maintained by the platform.
curl --request POST \
--url https://api.supergood.ai/integrations/<integration_id>/sessions \
--header 'Authorization: Basic <Base64 encoded token>' \
--header 'Content-Type: application/json' \
--data '{
"username": "[email protected]",
"password": "<password>",
"mfa": { "type": "totp", "code": "123456" },
"domain": "FIRM-AD"
}'
Example response
{
"authToken": "eyJhbGciOi...",
"expiresIn": 3600,
"user": {
"id": "u_wdx_9132a",
"name": "Paralegal A",
"entitlements": ["documents", "versions", "search", "audit"]
}
}
Documents
GET /documents: List and search documents by cabinet, profile fields (client, matter, docType, author), and/or full-text. Optionally return a time-limited download URL for the current version.
Query parameters
- cabinet: string (e.g., CORP, LIT)
- client: string (profile value)
- matter: string (profile value)
- docType: string (profile value)
- author: string (profile value)
- text: string (full-text search)
- updatedFrom, updatedTo: ISO 8601 timestamps
- includeDownloadUrl: true | false
- page, pageSize: integers
Example response
{
"items": [
{
"documentId": "wdx_doc_4f12a9",
"title": "Executed NDA - Acme",
"fileName": "NDA_Acme_Executed.pdf",
"extension": "pdf",
"sizeBytes": 482113,
"cabinet": "CORP",
"profile": {
"client": "ACME",
"matter": "2025-0012",
"docType": "NDA",
"author": "jdoe",
"createdDate": "2026-01-10"
},
"version": {
"number": 3,
"lastModifiedAt": "2026-02-14T16:20:11Z",
"checkedOutBy": null
},
"status": "available",
"security": { "access": "write", "ethicalWall": false },
"downloadUrl": "https://files.supergood.ai/d/wdx_doc_4f12a9?v=3&sig=..."
}
],
"page": 1,
"pageSize": 50,
"total": 1
}
Upload & File
POST /documents: Create and file a new document into a cabinet with required profile metadata. Supports large files via pre-signed upload tokens.
curl --request POST \
--url https://api.supergood.ai/integrations/<integration_id>/documents \
--header 'Authorization: Bearer <authToken>' \
--header 'Content-Type: application/json' \
--data '{
"cabinet": "LIT",
"profile": {
"client": "ACME",
"matter": "2026-0047",
"docType": "PLEADING",
"author": "aparker",
"description": "Motion to Dismiss"
},
"fileName": "Motion_to_Dismiss.docx",
"uploadToken": "upl_ce1f3a",
"security": { "inheritMatterSecurity": true }
}'
Example response
{
"documentId": "wdx_doc_b8a130",
"version": { "number": 1, "status": "checked_in" },
"cabinet": "LIT",
"profile": { "client": "ACME", "matter": "2026-0047", "docType": "PLEADING", "author": "aparker" },
"createdAt": "2026-02-20T09:42:33Z"
}
Versions
POST /documents/{documentId}/versions: Check in a new version of an existing document. Optionally force takeover if currently checked out by the same user and include a version comment.
curl --request POST \
--url https://api.supergood.ai/integrations/<integration_id>/documents/wdx_doc_b8a130/versions \
--header 'Authorization: Bearer <authToken>' \
--header 'Content-Type: application/json' \
--data '{
"uploadToken": "upl_7a22d9",
"versionType": "major",
"comment": "Updated exhibits and signature block",
"assumeCheckout": true
}'
Example response
{
"documentId": "wdx_doc_b8a130",
"version": {
"number": 2,
"status": "checked_in",
"comment": "Updated exhibits and signature block",
"checkedInAt": "2026-02-20T10:15:02Z",
"checkedInBy": { "userId": "u_wdx_9132a", "name": "Paralegal A" }
}
}
Technical Specifications
- Authentication: Username/password with optional MFA; supports AD/SSO/OAuth where enabled; service accounts or customer-managed credentials
- Response format: JSON with consistent schemas for documents, profiles, versions, and pagination
- Rate limits: Tuned for enterprise throughput while honoring customer entitlements and usage controls
- Session management: Automatic reauth and cookie/session rotation with health checks
- Data freshness: Near real-time indexing and metadata retrieval; handles async indexing windows for new files
- Security: Encrypted transport, scoped tokens, and audit logging; respects Worldox ACLs and ethical walls
- Webhooks: Optional asynchronous delivery for long-running workflows (e.g., bulk filing, reindex events, audit streams)
Performance Characteristics
- Latency: Sub-second responses for list/detail queries under normal load; upload/download times scale with file size
- Throughput: Designed for high-volume filing and search synchronization
- Reliability: Retry logic, backoff, and idempotency keys minimize duplicates and support at-least-once processing
- Adaptation: Continuous monitoring for UI/API changes with rapid adapter updates
Getting Started
- Schedule Integration Assessment
Book a 30-minute session to confirm your cabinets, profile groups, and authentication model.
- Supergood Builds and Validates Your API
We deliver a hardened Worldox adapter tailored to your workflows and entitlements.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adjustments as Worldox evolves.
Frequently Asked Questions
Q: Which Worldox modules can this integration cover?
Supergood supports workflows commonly used by legal DMS teams, including Document Search & Retrieval, Filing & Profiling (cabinets, index fields), Versioning & Check-In/Check-Out, and Audit/Reporting, subject to your licensing and entitlements. We scope coverage during integration assessment.
Q: How are check-outs and versions handled?
We model check-in/check-out semantics explicitly and enforce cabinet rules for major/minor versions. The Versions endpoint supports comments, takeover logic when permitted, and conflict-safe retries.
Q: Do you support iManage coexistence or migration?
Yes. We can normalize Worldox profiles to iManage workspace taxonomies, synchronize by client/matter, stream audit events, and provide bulk export/import utilities with idempotent mapping so you can operate during a phased migration.
Q: How are MFA and SSO handled for automation?
We support username/password + MFA and can operate behind AD/SSO/OAuth when enabled. Sessions are refreshed automatically with secure challenge handling and monitoring for expiry.
Q: Can we enforce ethical walls and respect ACLs?
Yes. All list, download, and filing operations respect user/group permissions and ethical walls. We can scope service accounts or per-user delegation depending on your security model.
Q: How do you handle large files and emails?
We use pre-signed, resumable uploads and downloads, preserve email metadata during filing, and report progress for long-running transfers.
Related Integrations
iManage API - Programmatically access iManage Work with Supergood
Ready to automate your Worldox workflows?
Supergood can have your Worldox integration live in days with no ongoing engineering maintenance.
