WorkGuru API Overview

Modified on Thu, 26 Jun at 10:23 AM

WorkGuru provides an API which can be used to develop third party integrations between your existing systems and your WorkGuru account. This API is provided as-is; planning, designing, developing and maintaining an integration through the API is the responsibility of you or your integrator/developer, with WorkGuru providing and supporting the listed API endpoints.


The process to access the WorkGuru API is straightforward. Create an API key within the appropriate WorkGuru account, then follow the authentication guide and once completed, review the API reference to find endpoints suitable for your integrations needs.


Here's an example of a request sent to the UK API:


GetAllCustomFieldDtosByType - CustomFieldTypes=1 will grab client custom fields:
curl --request GET \
--url 'https://ukapi.workguru.io/api/services/app/CustomField/GetAllCustomFieldDtosByType?CustomFieldTypes=1' \
--header 'Authorization: Bearer TOKEN' \
--header 'content-type: application/json' \
--data '{
"apiKey":"KEY",
"secret":"SECRET"
}'


Contact the WorkGuru team if you would like to investigate creating integrations using the WorkGuru API, but do not have any development resources available. While our team will not build an integration for you, we have a number of partners available that can help facilitate a solution for you and can provide further assistance.


For those wanting to connect to PowerBI, the attached example environment can be used as a starting guide. This environment is set up to run the Client Activity Lines Report and should only require adding your API key credentials to run.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article