API Reference

App

Login

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Start Beeper app setup

$client->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

LoginStartResponse

string setupRequestID

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

list<string> signInMethods

Available sign-in methods for this setup request.

Start Beeper app setup

PHP

HTTP

TypeScript

Python

Go

CLI Tool

PHP

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(accessToken: 'My Access Token');

$response = $client->app->login->start();

var_dump($response);

200 example

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

Returns Examples

200 example

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