---
title: Whoami
description: The 1 operation under whoami, as typed calls on the generated REST client.
---

{/* GENERATED by scripts/sdk-reference/generate.mjs from scripts/api-reference/openapi-snapshot.json. Do not edit: run `npm run docs:sdk:generate`. */}

# Whoami

**Available from `@codespar/sdk` 0.12.0, which is not on npm yet.** The published version today is 0.11.0, and it has no `cs.api`; 0.12.0 is on the `main` branch of [codespar-core](https://github.com/codespar/codespar-core). The examples below are not compiled against the installed package for that reason.

Every call below is `cs.api` reaching one operation of the OpenAPI document this page was generated from; the [REST client overview](/docs/api/sdk/rest-client) explains `request`, `response`, the option bag and the errors. The values are placeholders shaped by the document.

```ts
import { CodeSpar } from "@codespar/sdk";

const cs = new CodeSpar({ apiKey: process.env.CODESPAR_API_KEY });
```

### GET `/v1/whoami`

<Endpoint method="GET" path="/v1/whoami" />

What this credential is

```ts
const result = await cs.api.get("/v1/whoami");
```

Parameters, body and every documented response: [GET /v1/whoami in the HTTP reference](/docs/api/reference/whoami#get-v1whoami).