HTTP API reference
Every operation of the BuildBase HTTP API, by tag, generated from its OpenAPI description: method, path, sign-in, fields, answers and errors.
The API your app and @buildbase/sdk call: hosted sign-in, OAuth 2.0, and the session API that acts as one signed-in user of your app.
618 operations in 42 groups. 204 are fully described; the others have a page that says what is still missing.
Where to send requests
| Server | URL |
|---|---|
| BuildBase cloud | https://api.console.buildbase.app |
| A self-hosted install | {serverUrl} |
How a request signs in
Each operation page says which of these it needs.
| Credential | How to send it | What it is |
|---|---|---|
loginToken | Authorization: Bearer ... | An app end user's login token from hosted sign-in, for the same org as the request. |
orgQuery | the org query parameter | The org id the request is for, when there is no sign-in state. Not a credential. |
sessionId | the x-session-id header | An end user's session id, as the SDK sends it. POST /api/v1/public/token/exchange issues one for an org API token. |
signInState | the state header | The hosted sign-in state id. Names the org the request is for; not a credential. |
Operations by tag
| Tag | Operations | Fully described |
|---|---|---|
| Account | 2 | 2 |
| Accounts | 6 | 6 |
| Ad conversions | 2 | 2 |
| Add ons | 1 | 0 |
| Agent readiness | 1 | 1 |
| Analytics | 1 | 1 |
| Auth | 63 | 45 |
| Beta | 2 | 2 |
| Billing | 1 | 0 |
| Cart | 3 | 0 |
| Checkout | 3 | 0 |
| Connected agents | 2 | 2 |
| Consent | 2 | 1 |
| Credit packages | 1 | 0 |
| Device token | 1 | 1 |
| Devices | 3 | 3 |
| Discovery | 6 | 3 |
| Guest | 2 | 2 |
| Invitations | 4 | 0 |
| Item types | 2 | 0 |
| Items | 5 | 0 |
| Logout | 1 | 1 |
| Me | 182 | 0 |
| MFA | 8 | 7 |
| monday.com | 7 | 4 |
| Notifications | 8 | 6 |
| OAuth 2.0 | 12 | 10 |
| Passkeys | 3 | 3 |
| Plan group versions | 1 | 0 |
| Plans | 1 | 0 |
| Profile | 10 | 7 |
| Promotions | 1 | 0 |
| Push | 4 | 2 |
| Session | 3 | 3 |
| Sessions | 2 | 2 |
| Settings | 1 | 1 |
| Token | 1 | 1 |
| Tracking | 1 | 1 |
| Uploads | 2 | 2 |
| Users | 5 | 3 |
| Web analytics beacon | 1 | 1 |
| Workspaces | 251 | 79 |
For tools and agents
- The OpenAPI description these pages come from: public-v1.json
- Every fully described operation, one line each: llms/http-api.txt
- Any page as Markdown: its URL with
.mdadded