WorkGuru API Overview

Modified on Fri, 28 Mar at 10:51 AM

The API allows you to develop an integration between your existing systems and WorkGuru. WorkGuru provides and supports essentially "our" end of the integration. The developing an integration between your software and WorkGuru is your responsibility.

The process to access the WorkGuru API is straightforward. Create an API key and review the WorkGuru API swagger page for the appropriate endpoints available for your integration to connect to.

Here are a couple of examples using the UK API:

Auth:

curl --request POST \
--url https://ukapi.workguru.io/api/ClientTokenAuth/Authenticate/api/client/v1/tokenauth \
--header 'content-type: application/json' \
--data '{
"apiKey":"KEY",
"secret":"SECRET"
}'

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 don't have any development resources available. Please note that the WorkGuru support team do not provide active assistance for the API but 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.

Attachments (1)

pbix

WorkGuru Pow....pbix
13.3 KB

Was this article helpful?