mocop
Browse · Docs · Guide · Analyze

BuildBase public API

API by BuildBase · rest

The API @buildbase/sdk and an app call: the session API under /api/v1/public, hosted sign-in and OAuth under /api/v1/auth, beta sign-up, the monday.com integration and OAuth discovery. Generated from the running router by npm run openapi:generate (server/src/openapi). Do not edit by hand. What this document states is read from the code: every method and path Express serves, the request schemas validate() checks, the credential gates, rate limits and permission checks in front of each route. Summaries, descriptions and response bodies come from committed overlays, captured responses and route comments where they exist; otherwise an operation lists only the refusals its middleware sends. Rate limits are the defaults in the code; an install can change some of them through its environment. A limit with counts: some lets some requests through uncounted. Validation runs with type coercion ("1" is accepted for 1) and request strings are sanitised, so the documented types…

Endpoint: https://api.console.buildbase.app/

Verification: observed. Source: crawl.

Capabilities (640)

  • Get the API catalog that lists this server's HTTP APIs
  • Get an organization's OAuth authorization server metadata
  • Answer the age question on hosted sign-up or at sign-in
  • Register a pre-verified agent user account
  • Get a proof-of-work challenge for the hosted sign-up page
  • Get the hosted sign-in page configuration for an organization
  • Check whether the signed-in person must consent to an agent client
  • Approve an agent client's requested scopes
  • Deny an agent client's consent request
  • List the agents a user has connected for the app's backend
  • Revoke a user's grant to an OAuth client
  • Approve or deny a device authorization request
  • Look up the code a device shows and start a sign-in for it
  • Get the SSO connections offered for a pending enterprise sign-in choice
  • Start enterprise SSO discovery for an email address
  • Finish an enterprise SSO sign-in returning from WorkOS
  • Start an identity-provider-initiated enterprise SSO sign-in
  • Start an enterprise SSO sign-in for a discovered email address
  • Continue an enterprise SSO sign-in with the connection the person chose
  • Create a guest account and sign it in
  • Redeem a one-time impersonation ticket for the app's callback URL
  • Sign in with a password
  • Exchange a single-use login handoff code for the login token
  • Send a magic sign-in link to an email address
  • Check whether a magic link can be used in this browser
About · Contact · Privacy