Skip to content
VAIF Studio Docs
By meaning

Current user endpoints

5 endpoints at https://api.vaif.studio, generated from the API's OpenAPI document. The REST API page covers authentication, and All endpoints lists every group.

GET /me/badges

Your badges (Early, Founder, Creator) and the look your console wears

Response 200 (application/json)
{
  early: {
    number: number;
    tier: "early-100" | "early-500" | "early-1000";
    perkCredits: number;
    betaAccess: boolean;
  } | null;
  founder: {
    number: number | null;
  } | null;
  creator: boolean;
  consoleLook: "default" | "early" | "founder" | "creator";
  effectiveLook: "default" | "early-1000" | "early-500" | "early-100" | "founder" | "creator";
  welcomePending: boolean;
  wall: {
    optIn: boolean;
    displayName: string | null;
    hidden: boolean;
  } | null;
}

Errors: 401, 404, with the error body.

PUT /me/console-look

Choose the look your console wears from the badges you hold, or the default VAIF look

Request body (application/json, required)
{
  look: "default" | "early" | "founder" | "creator";
}
Response 200 (application/json)
{
  early: {
    number: number;
    tier: "early-100" | "early-500" | "early-1000";
    perkCredits: number;
    betaAccess: boolean;
  } | null;
  founder: {
    number: number | null;
  } | null;
  creator: boolean;
  consoleLook: "default" | "early" | "founder" | "creator";
  effectiveLook: "default" | "early-1000" | "early-500" | "early-100" | "founder" | "creator";
  welcomePending: boolean;
  wall: {
    optIn: boolean;
    displayName: string | null;
    hidden: boolean;
  } | null;
}

Errors: 400, 401, 404, with the error body.

POST /me/early/welcome-seen

Record that the early member welcome was shown

Response 200 (application/json)
{
  welcomePending: false;
}

Errors: 401, 404, with the error body.

PUT /me/early/wall

Join or leave the Early 100 wall, with a display name of your choosing

Request body (application/json, required)
{
  optIn: boolean;
  displayName?: string;
}
Response 200 (application/json)
{
  optIn: boolean;
  displayName: string | null;
  hidden: boolean;
}

Errors: 400, 401, 403, with the error body.

GET /me/creator

Your creator hub: your link and codes, your funnel and your money, totals only

Response 200 (application/json)
{
  link: string | null;
  codes: string[];
  funnel: {
    signedUp: number;
    building: number;
    payingLive: number;
  };
  money: {
    earnedCents: number;
    onHoldCents: number;
    payableCents: number;
    paidCents: number;
  };
  nextPayoutDate: string | null;
  payoutApproved: boolean;
  kit: {
    label: string;
    url: string;
  }[];
}

Errors: 401, 403, with the error body.