Skip to main content
Every API client can read our OpenAPI file. It describes every endpoint, parameter and response, and it needs no key:

​
Postman

Open our public Postman workspace, then fork the Scoutworks API collection. It comes with a Demo sandbox environment that already holds the sandbox key, so the first request works straight away.

Scoutworks API in Postman

Fork the collection and the Demo sandbox environment.
To use your own group, fork the environment, change baseUrl to https://api.scoutworks.app/api/v1 and set apiKey to your key. Store the key as a secret variable, so Postman hides it. You can also import the file yourself: Import → Link, then paste the OpenAPI address.

​
Bruno

1

Import the file

Choose Import Collection → OpenAPI V3 Spec, and paste the OpenAPI address.
2

Add the key

Open the collection settings. Under Auth, choose Bearer Token and paste the sandbox key or your own.
Bruno keeps collections as files in a folder. Do not commit a real key to git: put it in a Bruno environment marked secret.

​
Insomnia

Choose Import → From URL, and paste the OpenAPI address. Then set a Bearer Token on the collection.

​
Other tools

Most tools that speak OpenAPI can use the same file. For example, you can generate a typed client with OpenAPI Generator or openapi-typescript. The file is updated with every change to the API. See the changelog.