Overview
The majority of the functionality within Workup is available via our simple to use REST API. The API allows you to integrate Workup with your other tools, build custom processes or build workflows in tools such as Zapier or n8n. The API is secure and requires an API key to access which is linked to a specific user account. The read only API is available on our Essentials tier and the full read write API is available on our Professional tier. The API conforms to OpenAPI (OAS) v3.0.
Authentication
All calls to the API are authenticated with an API Key which is linked to a user account. You can create an API key via your Settings page. Go to the API tab on your Settings page and then press the Generate Key button. This will generate a text API Key which is required for all calls to the API and identifies yourself to the API so all API calls validate your identifty and applies your permissions and access to data within Workup. The API only allows you access to data
API Documentation and Testing
We have two options for viewing the details about the API: Swagger and Scalar documentation.
Swagger allows you to list all the API methods together with method parameters and data schemas. You can also test each method if you enter an API key. The methods will return data in JSON format.
Scalar provides more modern documentation on the API. It also provides code examples in a number of languages such as C# and python.
Links for Swagger and Scalar are below: