API Reference

User

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve the current user

client.user.retrieve(RequestOptionsoptions?): UserRetrieveResponse { id, email, github, 2 more }

GET/v0/user

Retrieve the currently authenticated user's information.

ReturnsExpand Collapse

UserRetrieveResponse { id, email, github, 2 more }

id: string

email: string | null

github: GitHub | null

username: string

name: string | null

object: "user"

Retrieve the current user

TypeScript

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

import Stainless from '@stainless-api/sdk';

const client = new Stainless({
  apiKey: process.env['STAINLESS_API_KEY'], // This is the default and can be omitted
});

const user = await client.user.retrieve();

console.log(user.id);

200 example

{
  "id": "id",
  "email": "email",
  "github": {
    "username": "username"
  },
  "name": "name",
  "object": "user"
}

Returns Examples

200 example

{
  "id": "id",
  "email": "email",
  "github": {
    "username": "username"
  },
  "name": "name",
  "object": "user"
}