In order to better connect with your existing tools and processes, Workpath provides a REST-ful JSON API. Common use cases include:
- Automatically updating KPIs from your internal BI database or similar tools
- Periodically querying all Goals, Key Results and Initiatives for reporting purposes
- Building internal dashboards (e.g. on a team or org level) that show Goals and their progress
- Automating processes like updating the progress on a Key Result
🚀 How to create an API Client
Hint: only administrators can create API Clients.
- In the bottom left corner, click Settings, then Organization Settings.
- Select the API Clients tab on the left.
- Click the blue "+" icon or the grey "Create API Client" button.
- Fill in the Name.
- Choose an access level:
- Read access — for tools that only need to pull data (e.g. BI tools, dashboards, reporting)
- Full access — for tools that also need to write or delete data
- Click Create API Client.
- Copy and securely store the Token shown at the bottom right of the screen.
⚙️ Access levels
When creating an API Client, you can now choose between two access levels:
- Read access limits the API Client to data retrieval only. This is the recommended option for BI tools, dashboards, and reporting setups.
- Full access allows reading, writing, and deleting data via the API.
All existing API Clients have been set to full access by default. If you'd like to switch an existing client to read-only, you'll need to replace it: delete the existing API Client in Organization Settings (this invalidates it immediately), then create a new one with read access.
❓ FAQ
Q: Do I have to replace my existing API Clients? No. Existing full-access clients continue to work as before. Switching to read-only is optional, but recommended if your use case only requires reading data.
For a list of all our available endpoints, technical specifications and examples, please refer to our API documentation.
Missing an endpoint or have an idea? Reach out at product@workpath.com — we're always happy to help!