API Reference

App

Login

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Start Beeper app setup

$ beeper-desktop app:login start

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

AppLoginStartResponse: object { setupRequestID, signInMethods }

setupRequestID: string

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

signInMethods: array of string

Available sign-in methods for this setup request.

Start Beeper app setup

CLI Tool

HTTP

TypeScript

Python

Go

CLI Tool

PHP

beeper-desktop app:login start \
  --access-token 'My Access Token'

200 example

{
  "setupRequestID": "setupRequestID",
  "signInMethods": [
    "string"
  ]
}

Returns Examples

200 example

{
  "setupRequestID": "setupRequestID",
  "signInMethods": [
    "string"
  ]
}