Retrieve

client.alias.username.valName.retrieve(, , ?): Val { id, author, createdAt, 5 more }

get/v2/alias/vals/{username}/{val_name}

Get a val

ParametersExpand Collapse

valName: string

params: ValNameRetrieveParams { username }

username: string

Username of the user whose val you are looking for

ReturnsExpand Collapse

Val { id, author, createdAt, 5 more }

A Val

id: string

The id of the val

formatuuid

author: Author { id, type, username }

id: string

type: "user" | "org"

Accepts one of the following:

"user"

"org"

username: string | null

createdAt: string

description: string | null

imageUrl: string | null

The URL of this val's image

links: Links { html, self }

html: string

The URL of this resource on Val Town

formaturi

self: string

The URL of this resource on this API

formaturi

name: string

privacy: "public" | "unlisted" | "private"

This resource's privacy setting. Unlisted resources do not appear on profile pages or elsewhere, but you can link to them.

Accepts one of the following:

"public"

"unlisted"

"private"

import ValTown from "npm:@valtown/sdk";

const client = new ValTown();

const val = await client.alias.username.valName.retrieve('val_name', { username: 'username' });

console.log(val.id);

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "author": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "type": "user",
    "username": "username"
  },
  "createdAt": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "imageUrl": "imageUrl",
  "links": {
    "html": "https://example.com",
    "self": "https://example.com"
  },
  "name": "name",
  "privacy": "public"
}

Returns Examples

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "author": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "type": "user",
    "username": "username"
  },
  "createdAt": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "imageUrl": "imageUrl",
  "links": {
    "html": "https://example.com",
    "self": "https://example.com"
  },
  "name": "name",
  "privacy": "public"
}