Endpoint Index

Purpose

Endpoint Index is the one-stop directory for every public Bead API path. Use it to locate a call quickly, copy a URL, or jump to the full reference page without scanning multiple sections.

What’s inside

Page	What you’ll find
Table View	A table listing every path, method, and one-line purpose. Ideal for quick look-ups or copy-paste.
Download OpenAPI / Postman	Direct links to the live OpenAPI JSON files (sandbox and production) and a note that ready-made Postman collections are coming soon.

How to use this section

1. Open Table View and find or Ctrl + F to find the endpoint you need.

2. Click the path (or follow the sidebar) to jump to the detailed docs for that call.

3. If you prefer machine-readable specs, grab the OpenAPI URL from Download OpenAPI / Postman and import it into Swagger, Insomnia, or Postman.

Endpoints are updated automatically whenever the platform releases; check the changelog for additions or breaking changes.