B Bookare Helpbookare.app →

Developers · Reference

OpenAPI description

The whole API in OpenAPI 3.1, for Postman, Insomnia, documentation tools and SDK generators.

  • On every venue: https://<venue>.bookare.app/api/v1/openapi.json, with that venue’s address as the server.
  • Here: /openapi.json, with https://{venue}.bookare.app/api/v1 as the server template.

It is generated from the code that runs the API, so it is always complete and current: every endpoint, field, type, which are required, the kinds of venue each applies to, authentication and examples.

Use it

  • Postman / Insomnia: Import → Link → paste the URL.
  • SDK: any OpenAPI 3.1 generator, for example npx @openapitools/openapi-generator-cli generate -i https://docs.bookare.app/openapi.json -g typescript-fetch -o ./bookare.
  • Types only: npx openapi-typescript https://docs.bookare.app/openapi.json -o bookare.d.ts.