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(ctx) (*AppLoginStartResponse, error)

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

type AppLoginStartResponse struct{…}

SetupRequestID string

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

SignInMethods []string

Available sign-in methods for this setup request.

Start Beeper app setup

Go

HTTP

TypeScript

Python

Go

CLI Tool

PHP

package main

import (
  "context"
  "fmt"

  "github.com/beeper/desktop-api-go"
  "github.com/beeper/desktop-api-go/option"
)

func main() {
  client := beeperdesktopapi.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  response, err := client.App.Login.Start(context.TODO())
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.SetupRequestID)
}

200 example

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

Returns Examples

200 example

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