The Oneflow API documentation describes all Oneflow public APIs and their methods used for creating and interacting with Oneflow contracts.
All API references are grouped into several main categories according to their function:
| Category | Operations |
|---|---|
| Account | Get information about the current Oneflow account (country, logo, etc.). |
| User | Get a list of users in a Oneflow account. |
| Core | Check Oneflow API availability and authenticate Oneflow users. |
| Contact | Create, retrieve, update and delete contacts in a workspace. |
| Contract | Create, retrieve, update, publish, and delete contracts. Also, create, retrieve and update contract-related elements (parties, participants, data fields, comments, reminders, and products). |
| Folder | Create folders inside Workspaces to manage and organize contract documents. |
| Templates | Retrieve specific or all templates available for a specified user. |
| Helpers | Get data essential for creating contracts. |
| Template types | Retrieve, update, and delete template types for a specified user. |
| Events | Retrieve specific or all events for a specified contract. |
| Files | Add new and retrieve existing files from a specified contract. |
| Workspace | Retrieve specific or all workspaces for a specified user. |
| Tag | Create and retrieve tags in a Oneflow account. |
| Webhooks | Create, retrieve, update, and delete webhooks in a Oneflow account. |
Base URL
Use the following base URL while working with APIs: https://api.oneflow.com/v1
Please, read more information about our environments in the Authentication and authorization section.
Postman collection
If you'd like to create a Postman collection from our API for testing and development,
you can download the file here: Oneflow_API_version_1.yml.
Please reference the Postman documentation for how to create a Postman collection from an OpenAPI specification.