Sample Postman collection for Uptick API
Aleks Petrovic avatar
Written by Aleks Petrovic
Updated over a week ago

In this article you can find sample files and instruction for configuring Postman to interact with the Uptick API.

First, download the files at the bottom of this article.

Setting up the environment file

Once you've imported the environment file, you should see something like this:

You'll have the client_id and client_secret from the previous step, connecting to the Uptick API, and your username/password for accessing the API are created like any normal account:

Using the Postman collection

Once you've imported the collection,

1) set the "environment" in the top right hand corner, which will now use the variables you have defined above.

2) click the Collections tab, then "Example Uptick API usage", then "Authorization", and you should see something like this:

3) Clicking the "Get New Access Token" will exchange your username and password for an Access Token that can be used to access the API.

4) If your credentials were correct, you can now click "Use Token" which saves your token into your collection so you can play with the APIs. You will need to repeat this step if your token expires.

There are five example requests included in this Postman collection:

  • Get Access Token, this shows the manual process of obtaining an access token. You don't need this if you're using Postman, but you will need it if you're connecting up an external system.

  • Get Refresh Token, this shows the manual process of swapping an expired access_token using a refresh_token. You don't need this if you're using Postman.

  • List Clients, which demonstrates how you can list the set of clients within Uptick.

  • Get Single Client, which returns the first client in the system (providing the client exists).

  • Create Property, which will create a new property in the system.

Did this answer your question?