OpenAPI spec

The spec

The spec is at:

https://docs.bluereacher.com/openapi.json

It covers every route in this reference. Each operation carries the scope it needs, its parameters, request body and example responses. The security scheme is a bearer token: the OAuth access token your app receives at install. See Authentication.

Import into Postman

1. In Postman, choose Import, then Link.
2. Paste https://docs.bluereacher.com/openapi.json and choose Import.
3. Open the collection's Authorization tab, choose Bearer Token, and paste an access token.
4. If Postman does not set the base URL, use https://api.bluereacher.com. The paths in the spec already start with /v1.

Access tokens expire after 24 hours. Refresh and paste a new one when you see a 401.

Import into Insomnia or Bruno

Both accept the same spec URL as an OpenAPI import. Set the bearer token at the collection level, the same way as in Postman.

Generate a client

# TypeScript
npx openapi-typescript https://docs.bluereacher.com/openapi.json -o bluereacher.d.ts

# Python
openapi-python-client generate --url https://docs.bluereacher.com/openapi.json

# Go
openapi-generator-cli generate \
  -i https://docs.bluereacher.com/openapi.json \
  -g go \
  -o ./bluereacher-go

A generated client gives you types and request shapes. It does not handle the OAuth install or token refresh for you. Build those from the Authentication guide, and refresh on every 401.

Reading it with an AI assistant

The same spec, with the plain-text docs at https://docs.bluereacher.com/llms-full.txt, is what to hand a coding assistant. See Build with AI.