API Reference

App

Login

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Send setup sign-in code

client.app.login.email(LoginEmailParams { email, setupRequestID } body, RequestOptionsoptions?): void

POST/v1/app/setup/email

Send a sign-in code to the user email address for app setup.

ParametersExpand Collapse

body: LoginEmailParams { email, setupRequestID }

email: string

Email address to send the sign-in code to.

formatemail

setupRequestID: string

Setup request ID returned by the start step.

Send setup sign-in code

TypeScript

HTTP

TypeScript

Python

Go

CLI Tool

PHP

import BeeperDesktop from '@beeper/desktop-api';

const client = new BeeperDesktop();

await client.app.login.email({ email: 'dev@stainless.com', setupRequestID: 'setupRequestID' });

Returns Examples