Skip to content
Beeper Developer Docs
Download Beeper
API Reference
App
Login

Start Beeper app setup

app.login.start() -> LoginStartResponse
POST/v1/app/setup/start

Start setting up Beeper Desktop or Beeper Server. The flow supports existing Beeper accounts and new account creation.

ReturnsExpand Collapse
class LoginStartResponse: …
setup_request_id: str

Setup request ID to use in the next sign-in step.

sign_in_methods: List[str]

Available sign-in methods for this setup request.

Start Beeper app setup

from beeper_desktop_api import BeeperDesktop

client = BeeperDesktop()
response = client.app.login.start()
print(response.setup_request_id)
{
  "setupRequestID": "setupRequestID",
  "signInMethods": [
    "string"
  ]
}
Returns Examples
{
  "setupRequestID": "setupRequestID",
  "signInMethods": [
    "string"
  ]
}