Get the instance profile | Memos unofficial

2 status codes

200Returns the instance profile, including version, demo status, instance URL, administrator information, setup state, access mode, and any configured challenge.

versionstringoptional

Version is the current version of instance.

demobooleanoptional

Demo indicates if the instance is in demo mode.

instanceUrlstringoptional

Instance URL is the URL of the instance.

adminobjectoptional

The first administrator who set up this instance, for display purposes. May be null on an instance that has lost all admins; use needs_setup to determine whether initial setup is actually required.

commitstringoptional

Commit is the current build commit of instance.

needsSetupbooleanoptional

NeedsSetup is true when the instance has no users yet and requires initial setup (creating the first admin account). Unlike a null admin, this stays false once any user exists, so an instance that has lost its admins is not mistaken for a fresh install.

accessModestringoptional

Access mode controls whether unauthenticated users may access instance content.

Allowed:INSTANCE_ACCESS_MODE_UNSPECIFIEDINSTANCE_ACCESS_MODE_PRIVATEINSTANCE_ACCESS_MODE_PUBLIC

challengeobjectoptional

A proof-of-humanity challenge the deployment requires on signup and password sign-in. Absent when none is configured, which is the case on every self-hosted instance.

defaultReturns a standard error object containing an error code, developer-facing message, and optional details.

codeintegeroptional

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestringoptional

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsarray<object>optional

A list of messages that carry the error details. There is a common set of message types for APIs to use.

import { Client } from "memos-unofficial-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
});

const result = await client.profile.list();

{
  "version": "example_value",
  "demo": true,
  "instanceUrl": "https://example.com",
  "admin": {
    "name": "Example Name",
    "role": "ROLE_UNSPECIFIED",
    "username": "janedoe",
    "email": "user@example.com",
    "displayName": "Example Name",
    "avatarUrl": "https://example.com",
    "description": "Example description",
    "password": "password123",
    "state": "STATE_UNSPECIFIED",
    "createTime": "2026-01-15T09:00:00Z",
    "updateTime": "2026-01-15T09:00:00Z"
  },
  "commit": "example_value",
  "needsSetup": true,
  "accessMode": "INSTANCE_ACCESS_MODE_UNSPECIFIED",
  "challenge": {
    "provider": "Example Academy Trust",
    "siteKey": "example_key_abc123"
  }
}

Response