Go here to view our full API docs

Using UpKeep's public API documentation is extremely powerful and can be used for a whole suite of integrations such as integrations with SAP, Zendesk, Oracle, IoT platforms (using meters), and more! One of the most common requests is to use UpKeep's public APIs to fetch data to run complex reports outside of UpKeep so customers can aggregate data from different sources such as IoT platforms.

Here's a quick guide on how to use UpKeep's public APIs using an application called Postman. Postman is a simple API Development Environment and is just used for testing purposes:

  1. Testing UpKeep’s Authentication API

UpKeep's authentication starts with a username and password. 

***Please note, that the general best practice is to create a user called api@YOURCOMPANY.COM . Ensure this user type is an "Admin". When this user's username / password changes, you will also need to update the session token as well.

You'll be able to then create a generic username and password for which you'll receive a session token as a response. This session token will then be used for all of the subsequent API calls.

2. Create a work order through our API

An example of using a POST request in UpKeep. Ensure you've selected the right content types for the headers, submitted a POST request, and that the URL structure follows our API documentation. You'll receive a response back in JSON format.

3. Fetching work orders through the API

This is an example using UpKeep's GET request through postman. You can also use parameters to pass in specific details about that work order you want to filter by in the GET request

Did this answer your question?