Skip to content
  • Auto
  • Light
  • Dark
Get Started

Retrieve

Retrieve
client.me.profile.retrieve(RequestOptionsoptions?): idstringbiounionemailstringlinksLinksprofileImageUrluniontierunionurlstringusernameunionProfileRetrieveResponse
get/v1/me

Get profile information for the current user

Returns
ProfileRetrieveResponse

Your user information, with tier and email included

Hide ParametersShow Parameters
idstring

The ID of this user

formatuuid
biounion
string | null

The user’s biography, if they have provided one

emailstring

Your email address

profileImageUrlunion
string | null

URL that points to the user’s profile image, if one exists

formaturi
tierunion
"free" | "pro" | null

Your account tier

Hide ParametersShow Parameters
"free"
"pro"
urlstring

URL of this user’s profile on Val Town’s website

formaturi
usernameunion
string | null

The user’s handle that they chose for themselves. Does not include the @ symbol

import ValTown from '@valtown/sdk';

const client = new ValTown();

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

console.log(profile.id);
200 Example
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "bio": "bio",
  "email": "email",
  "links": {
    "self": "https://example.com"
  },
  "profileImageUrl": "https://example.com",
  "tier": "free",
  "url": "https://example.com",
  "username": "username"
}