Skip to content

SDK: me

The me methods of the Overlane TypeScript SDK, with their signatures. Generated from the SDK types.

Updated View as MarkdownOpen in ChatGPTOpen in Claude

The me area has 4 methods on the client. Each takes one object of path, query and body arguments and an optional CallOptions, and returns a promise of the response body. A refused call rejects with OverlaneApiError (see the SDK index).

meChannelGet

Which build of the hosted app the caller sees and why: their own pick, the team’s channel and lock

  • Request: GET on /v1/me/channel
meChannelGet(args?: Record<string, never>, options?: CallOptions): Promise<ViewerChannel>

meChannelPut

Pick the build you see: follow the team, stable or beta; the internal build is for Overlane staff only

  • Request: PUT on /v1/me/channel
meChannelPut(args: { body: PutViewerChannel }, options?: CallOptions): Promise<ViewerChannel>

meDelete

Delete the caller’s own account: leaves every team, removes personal rows and returns a receipt with counts per table (a person does this; refused while the caller is the last owner of a team that still has other members)

  • Request: DELETE on /v1/me/account
meDelete(args?: Record<string, never>, options?: CallOptions): Promise<AccountDeletionReceipt>

meGet

Who the bearer token belongs to

  • Request: GET on /v1/me
meGet(args?: Record<string, never>, options?: CallOptions): Promise<WhoAmI>
Navigation

Type to search…

↑↓ navigate↵ selectEsc close

Overlane Agent

Ask about the docs. Answers are quoted from the pages, with links. This panel cannot change anything.

    Questions are answered in your browser from the docs index. Nothing you type here is stored or sent anywhere.