Get the OpenAPI description
Get the OpenAPI description.
GET
/v1/openapi.jsonRequest
| Method and path | GET/v1/openapi.json |
|---|---|
| Base URL | https://api.boxline.dev |
| Authentication | None. Anyone can call it. |
curl "https://api.boxline.dev/v1/openapi.json"import { Boxline } from "@boxline/sdk";const bx = new Boxline(); // reads BOXLINE_API_KEY and BOXLINE_API_URLconst spec = await bx.openapi();console.log(Object.keys(spec.paths as object).length, "paths");from boxline import Boxlinebx = Boxline() # reads BOXLINE_API_KEY and BOXLINE_API_URLspec = bx.openapi()print(len(spec["paths"]), "paths")Responses
200 OK
The OpenAPI 3.1 document.
Fields
{}Learn more
These docs describe a beta API. Endpoints, fields and SDK methods may change before general availability; breaking changes will be listed in the changelog.