canonical: https://jentic.com/apis/workflowmax.com/workflowmax

# WorkflowMax API

WorkflowMax project management and job costing API. Manage jobs, clients, staff, timesheets, costs, leads, quotes, invoices, suppliers, and purchase orders. The API exposes 62 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically get current user, list accounts. Covers 62 operations with oauth2 authentication.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- Get current user
- List accounts
- Create custom field
- Update custom field
- Monitor WorkflowMax API operational status and events

## Use cases

### Payments Operations

Use the WorkflowMax API to perform payments operations programmatically. The API provides 62 endpoints covering core functionality including get current user, list accounts, list roles.

Example prompt: Call GET `/v2/me` to get current user

### Automated Authentication Management

Automate authentication operations by combining multiple WorkflowMax API endpoints. Agents can list accounts and then list roles in a single workflow.

Example prompt: Call GET `/v2/accounts` to list accounts, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call WorkflowMax API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle oauth2 tokens manually.

Example prompt: Search Jentic for 'get current user', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/v2/me` | Get current user |
| GET | `/v2/accounts` | List accounts |
| GET | `/v2/roles` | List roles |
| POST | `/v2/custom-fields` | Create custom field |
| GET | `/v2/custom-fields` | List custom fields |
| PUT | `/v2/custom-fields/{UUID}` | Update custom field |
| GET | `/v2/taxes` | List taxes |
| GET | `/v2/business-structures` | List business structures |

## Key resources

- **Authentication** — Operations related to Authentication
- **Client Groups** — Operations related to Client Groups
- **Clients** — Operations related to Clients
- **Costs** — Operations related to Costs
- **Jobs** — Operations related to Jobs

## Why Jentic

- **Setup:** Wiring the WorkflowMax API by hand means implementing its OAuth2 flow and refreshing tokens across 62 operations yourself. Through Jentic you install once, import the WorkflowMax API from the API Directory, store the OAuth2 credential once, and your agent calls it.
- **Permission scoping:** The WorkflowMax API puts the custom-field id in the URL path (`/v2/custom-fields/{UUID}`), so a rule can pin your agent to one custom field. You choose the operations it may call, so writes like updating a custom field are not included unless you add them, and read-only calls such as fetching the current user or accounts can stand alone.
- **Credential handling:** Your WorkflowMax API OAuth2 credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get the current user' or 'list tax rates', and Jentic returns the matching WorkflowMax API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the WorkflowMax API use?

The WorkflowMax API uses OAuth 2.0 for authorization. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I get current user with the WorkflowMax API?

Yes. Use the GET `/v2/me` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the WorkflowMax API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I get current user through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get current user'. Jentic returns the matching WorkflowMax API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the WorkflowMax API have?

The WorkflowMax API exposes 62 endpoints covering authentication, client groups, clients operations.

### Can I limit what my agent is allowed to do with the WorkflowMax API?

Yes. Because Jentic One is self-hosted, your own rules decide which of the 62 WorkflowMax API operations your agent may call and which OAuth2 credential it uses. You choose the operations, so a write such as PUT `/v2/custom-fields/{UUID}` to update a custom field is excluded unless you add it, while read-only calls like GET `/v2/me` for the current user or GET `/v2/accounts` can stand alone. Since the custom-field id sits in the URL path, a rule can also pin the agent to a single custom field.