Skip to content

Postman collection

Generated directly from the same OpenAPI document as the API reference — never hand-maintained, so it can't drift from the live schema.

Download: /downloads/lucibook-api.postman_collection.json

The underlying OpenAPI document is served alongside it: /openapi.json (or /openapi.yaml) — the same snapshot the reference page renders from.

Import

  1. Postman → Import → paste the URL above (or drag the downloaded file in).
  2. The collection's baseUrl variable defaults to the production API origin — change it to point at staging if that's what you're testing against.
  3. Authorization is pre-configured as OAuth 2.0, Authorization Code with PKCE. Set your own client_id (a public client — no secret ships in the collection); Postman walks you through the browser consent flow and stores the resulting token on the collection.

The collection only covers Authorization Code + PKCE — custom connections (the client_credentials grant) aren't available to partners yet, see Custom connections.