---
title: "Read the caller's commit-leaderboard state"
method: GET
path: "/api/leaderboard/me"
tags: ["leaderboard"]
---

# Read the caller's commit-leaderboard state

`GET /api/leaderboard/me`

## Request

- Base URL: `https://www.immersivecommons.com`
- URL: `https://www.immersivecommons.com/api/leaderboard/me`
- Auth: HTTP bearer

Clerk session or agt_ token with `leaderboard:manage`. Returns opt-in flag, linked GitHub username, and current weekly rank if rendered.

## Response `200`

Leaderboard state for the caller.

- LeaderboardMeResponse
  - `ok` boolean, required
  - `optIn` boolean
  - `github_username` string
  - `github_link_source` 'oauth' | 'agent_pat'
  - `github_verified_at` string, date-time
  - `this_week` object
    - `count` integer
    - `rank` integer
    - `total` integer
    - `generated_at` string, date-time

## Other responses

- `401`: No auth.
- `403`: Scope not authorized.
- `500`: Read failed.

---

[API](https://skmtc.dev/immersivecommons/apis/immersive-commons-agent-rest-api.md) · [All operations](https://skmtc.dev/immersivecommons/apis/immersive-commons-agent-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/immersivecommons/apis/immersive-commons-agent-rest-api/revisions/be67c1f67c27?raw)