List optin

Returns the caller's own public-listing preference and their org's, each with whether the caller may change it.

GET /v1/leaderboard/optin

Leaderboard → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/leaderboard/optin`
Method	`GET`
Operation	`get_leaderboard_optin`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns the caller's own public-listing preference and their org's, each with whether the caller may change it. Public listing is opt-in and private by default, so a fresh caller reads listed=false for both.

Request

GET /v1/leaderboard/optin takes no parameters and no body — the credential is the whole request.

Response

Status	Body	Meaning
`200`	leaderboard.optinView	ok
`default`	problem-details	refused

200 body — 8 fields.

Field	In	Type	Always	Description
`org`	body	leaderboard.orgOptinView	—
`org.canManage`	body	boolean	—	CanManage is true only for an admin of this org (or a platform SuperAdmin) — the callers whose write of the org preference will be accepted.
`org.display`	body	string	—	Display is the name shown for the org on that board.
`org.listed`	body	boolean	—	Listed is true when the org has opted onto the cross-org global board.
`user`	body	leaderboard.userOptinView	—
`user.canSet`	body	boolean	—	CanSet is false when the caller's ledger identity cannot be resolved (no user name on the principal).
`user.handle`	body	string	—	Handle is the display name on the caller's listed row.
`user.listed`	body	boolean	—	Listed is true when the caller's board row is published under Handle to other viewers.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo leaderboard optin get

.ts

.py

.go

.rs

.java

import { Configuration, LeaderboardApi } from 'hanzoai';

const api = new LeaderboardApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getLeaderboardOptin();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import LeaderboardApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = LeaderboardApi(client).get_leaderboard_optin()

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.LeaderboardAPI.GetLeaderboardOptin(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, leaderboard_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = leaderboard_api::get_leaderboard_optin(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.LeaderboardApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new LeaderboardApi(client).getLeaderboardOptin();

curl https://api.hanzo.ai/v1/leaderboard/optin \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool leaderboard, op get_leaderboard_optin — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "leaderboard",
         "arguments": {
           "op": "get_leaderboard_optin",
           "input": {}
         }
       }
     }'

Leaderboard API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList activity NextList leaderboard