Retrieve

API Reference

Alias

Username

Retrieve

get/v1/alias/{username}

Get basic details about a user, given their username

Path Parameters

usernamestring

Returns

idstringbiostringlinksobjectprofileImageUrlstringurlstringusernamestringUser

HTTPTypeScript

curl https://api.val.town/v1/alias/$USERNAME

200 Example

{
  "id": "00000000-0000-0000-0000-000000000000",
  "bio": "Hello world",
  "links": {
    "self": "https://example.com"
  },
  "profileImageUrl": null,
  "url": "https://val.town/u/tmcw",
  "username": "tmcw"
}