Skip to content
Get Started

Retrieve

client.me.profile.retrieve(RequestOptionsoptions?): ProfileRetrieveResponse { email, tier }
get/v1/me

Get profile information for the current user

ReturnsExpand Collapse
ProfileRetrieveResponse extends User { id, bio, links, 4 more } { email, tier }

Your user information, with tier and email included

email: string | null

Your email address

tier: "free" | "pro" | "business" | null

Your account tier

Accepts one of the following:
"free"
"pro"
"business"
Retrieve
import ValTown from "npm:@valtown/sdk";

const client = new ValTown();

const profile = await client.me.profile.retrieve();

console.log(profile);
{
  "id": "00000000-0000-0000-0000-000000000000",
  "bio": "Hello world",
  "links": {
    "self": "https://example.com"
  },
  "profileImageUrl": null,
  "type": "user",
  "url": "https://val.town/u/tmcw",
  "username": "tmcw",
  "email": "email",
  "tier": "free"
}
Returns Examples
{
  "id": "00000000-0000-0000-0000-000000000000",
  "bio": "Hello world",
  "links": {
    "self": "https://example.com"
  },
  "profileImageUrl": null,
  "type": "user",
  "url": "https://val.town/u/tmcw",
  "username": "tmcw",
  "email": "email",
  "tier": "free"
}