Me

Fetch the current authenticated user (useful as a health check after setting up auth).

The me object

The me object is a small summary of the authenticated user. It’s designed for “is my token valid?” checks and integration setup flows.

Properties

Name

id

Type

integer

Description

Unique identifier for the authenticated user.
Name

email

Type

string

Description

Email address for the authenticated user.
Name

name

Type

string

Description

Display name for the authenticated user.
Name

is_admin

Type

boolean

Description

Whether the user has admin access.
Name

is_lister

Type

boolean

Description

Whether the user is a lister (publishes listings).
Name

plan

Type

string

Description

Lister plan (free, standard, pro).

GET/v1/me/

Fetch the current authenticated user

This endpoint is the fastest way to validate your token. It returns a small user summary in me.

Required scope

Tokens must include read:me (OAuth tokens and API keys). Older API keys created before scopes were introduced are treated as full-access keys until you rotate them.

Rate limits

Requests are rate limited. If you hit 429, back off and retry with a short delay (and jitter).

Request

GET

/v1/me/

curl -s \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.twentybaan.com/v1/me/

GET

/v1/me/

const token = process.env.TWENTYBAAN_API_KEY;

const res = await fetch("https://api.twentybaan.com/v1/me/", {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());

GET

/v1/me/

type TwentybaanMeResponse =
  | {
      ok: true;
      me: {
        id: number;
        email: string;
        name: string;
        is_admin: boolean;
        is_lister: boolean;
        plan: string;
      };
    }
  | { ok: false; error: string };

const token = process.env.TWENTYBAAN_API_KEY!;

const res = await fetch("https://api.twentybaan.com/v1/me/", {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const data = (await res.json()) as TwentybaanMeResponse;

if (!res.ok || !data.ok) {
  throw new Error("Request failed");
}

console.log(data.me);

GET

/v1/me/

import os
import requests

token = os.environ["TWENTYBAAN_API_KEY"]

res = requests.get(
  "https://api.twentybaan.com/v1/me/",
  headers={
    "Accept": "application/json",
    "Authorization": f"Bearer {token}",
  },
  timeout=30,
)
res.raise_for_status()
print(res.json())

GET

/v1/me/

<?php

$token = getenv('TWENTYBAAN_API_KEY') ?: '';

$ch = curl_init("https://api.twentybaan.com/v1/me/");
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer " . $token,
  ],
]);

$body = curl_exec($ch);
$status = (int) curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo "HTTP {$status}\n";
echo $body;

GET

/v1/me/

using System;
using System.Net.Http;
using System.Net.Http.Headers;

var token = Environment.GetEnvironmentVariable("TWENTYBAAN_API_KEY") ?? "";

using var client = new HttpClient();
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);

var res = await client.GetAsync("https://api.twentybaan.com/v1/me/");
var body = await res.Content.ReadAsStringAsync();

Console.WriteLine((int)res.StatusCode);
Console.WriteLine(body);

GET

/v1/me/

require "net/http"
require "json"

token = ENV.fetch("TWENTYBAAN_API_KEY")
uri = URI("https://api.twentybaan.com/v1/me/")

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Authorization"] = "Bearer #{token}"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(req)
end

puts res.code
puts res.body

GET

/v1/me/

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
  "time"
)

func main() {
  token := os.Getenv("TWENTYBAAN_API_KEY")
  req, err := http.NewRequest("GET", "https://api.twentybaan.com/v1/me/", nil)
  if err != nil {
    panic(err)
  }

  req.Header.Set("Accept", "application/json")
  req.Header.Set("Authorization", "Bearer "+token)

  client := &http.Client{Timeout: 30 * time.Second}
  res, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer res.Body.Close()

  body, _ := io.ReadAll(res.Body)
  fmt.Println(res.Status)
  fmt.Println(string(body))
}

Response

{
  "ok": true,
  "me": {
    "id": 123,
    "email": "you@example.com",
    "name": "Your Name",
    "is_admin": false,
    "is_lister": true,
    "plan": "standard"
  }
}