API Reference

Postman Collection

Experiment with the Opal API using Postman's user-friendly UI.

Overview

We've created a Postman collection to make it easy for you to make experimental calls to our API. This collection provides a library of ready-made API calls that you can edit and/or directly hit "Send" on, for your own Opal setup.

The collection's JSON is hosted here. This collection should not be shared publicly.

Using Postman

To use the Postman Collection, follow these steps:

  1. In your own Postman workspace, select Import. Go to the Link tab, paste the above JSON link, and finish the import.

  1. Enter your Opal API token by clicking Opal API in the left sidebar, then navigating to Authorization > Token. To generate an API token, check out our instructions under Authentication.

  1. (optional) If you need to customize the Opal server base URL, navigate to Variables > baseUrl > Current Value. Enter your alternative base URL here. You'll need to do this if your organization is running an on-prem version of Opal with its own custom URL, or if you want to hit a sandbox version of the Opal server.

  1. Click any of the API endpoints in the left sidebar to get started testing!