The Application Programming Interface (API) allows you to integrate with your other business systems.
Common uses of the API include:
- Automating notifications or workflows through third‑party apps
- Connecting with reporting and business intelligence tools
- Integrating with CRM or project management platforms
- Reducing manual data entry and keeping information consistent across systems
Technical details
Authentication for both API v1 and API v2 uses OAuth 2.0. For full authentication steps, token lifetimes, and required request headers, see API Authentication.
For API contract documentation and endpoint references, use the links below:
API v1 — quick summary
API v1 is the legacy API, using XML over HTTP. It supports OAuth 2.0 and remains available for integrations that rely on functionality not yet exposed in API v2.
Please note: API v1 will be retired on 15th June 2027. After that date, V1 endpoints will be switched off.
Until 15 June 2027, we'll continue to support API V1 for critical issues only - e.g. failure to connect, an existing endpoint not working. We will not be building any functional enhancements on V1 from now on. Any feature requests or improvement asks for the API should be directed to API V2.
API v2 — quick summary
API v2 is the modern JSON-based API and the recommended choice for new integrations. It also supports OAuth 2.0, along with improved filtering and richer request and response payloads.
Key API v2 features:
- JSON requests and responses, suited to modern development environments
- Smarter data retrieval (for example, filtering by
lastModifiedand including related data) - Broader and expanding endpoint coverage
Which API should I use?
- Use API v2 for all new integrations.
Feedback and support
When contacting support, include the request_id from the API response along with the following information:
- Client ID and Organisation ID
- Exact endpoint and UTC timestamp
- Sample request and response (with secrets removed)
Frequently Asked Questions
With API v1 ending, what should I do?
You will need to migrate to API v2 before the retirement date to continue using the WorkflowMAX API.
What's different in API v2?
API v2 is JSON instead of XML and has the same OAuth 2.0 authentication. It contains updated endpoint naming and more flexible query parameters. V2 also continues to receive new capabilities (e.g., recent capacity planning endpoints, webhooks) that V1 won't receive.