KB
Sign InPublic REST API
OneDesk has a public REST API available for you to use to push or pull information from your OneDesk account. This allows you to connect and synchronize the data between OneDesk and a third-party application without going through the interface. Available in a OneDesk enterprise account.
Accessing the OneDesk API
If you are interested in using OneDesk’s public API, head to our public API page. On this page you will find an introduction to OneDesk’s API, and can start implementing the changes you wish to make on your end.
Example: Start work timer with the API
When you have selected the action you wish to use, you can see the request parameters and response fields, sample requests, and sample responses involving the specific action.
For example, let’s look at the “Start Work Timer” request. Under the 'Parameters' heading, we see we require a user’s external ID, and the external ID of the item to start the timer for.
We will first need to run a call to retrieve these IDs. To see how to retrieve these details, see here.
Under 'Responses' we see we are returned a string of code (the result of the operation), the amount of work already spent on the timer, and the result of the activity - whether it failed (and why), or whether it succeeded.
In addition to the request parameters and response fields, you can see an example request and example response for the “Start Work Timer” action.
These will help guide you along the way in utilizing this action - the item ID from the request parameters are clearly visible in the request examples, as well as the expected responses outlined in the response fields.