Memos API
  1. UserService
Memos API
  • AuthService
    • SignIn signs in the user with the given username and password.
      POST
    • SignInWithSSO signs in the user with the given SSO code.
      POST
    • SignOut signs out the user.
      POST
    • SignUp signs up the user with the given username and password.
      POST
    • GetAuthStatus returns the current auth status of the user.
      POST
  • IdentityProviderService
    • ListIdentityProviders lists identity providers.
      GET
    • CreateIdentityProvider creates an identity provider.
      POST
    • UpdateIdentityProvider updates an identity provider.
      PATCH
    • DeleteIdentityProvider deletes an identity provider.
      DELETE
    • GetIdentityProvider gets an identity provider.
      GET
  • InboxService
    • ListInboxes lists inboxes for a user.
    • UpdateInbox updates an inbox.
    • DeleteInbox deletes an inbox.
  • MarkdownService
    • GetLinkMetadata returns metadata for a given link.
    • RestoreMarkdownNodes restores the given nodes to markdown content.
    • StringifyMarkdownNodes stringify the given nodes to plain text content.
    • ParseMarkdown parses the given markdown content and returns a list of nodes.
  • MemoService
    • ListMemos lists memos with pagination and filter.
    • CreateMemo creates a memo.
    • DeleteMemoReaction deletes a reaction for a memo.
    • UpdateMemo updates a memo.
    • GetMemo gets a memo.
    • DeleteMemo deletes a memo.
    • ListMemoComments lists comments for a memo.
    • CreateMemoComment creates a comment for a memo.
    • ListMemoReactions lists reactions for a memo.
    • UpsertMemoReaction upserts a reaction for a memo.
    • ListMemoRelations lists relations for a memo.
    • SetMemoRelations sets relations for a memo.
    • ListMemoResources lists resources for a memo.
    • SetMemoResources sets resources for a memo.
    • ListMemos lists memos with pagination and filter.
    • DeleteMemoTag deletes a tag for a memo.
    • RenameMemoTag renames a tag for a memo.
  • ResourceService
    • ListResources lists all resources.
    • CreateResource creates a new resource.
    • GetResource returns a resource by name.
    • DeleteResource deletes a resource by name.
    • UpdateResource updates a resource.
    • GetResourceBinary returns a resource binary by name.
  • UserService
    • ListUsers returns a list of users.
      GET
    • CreateUser creates a new user.
      POST
    • ListAllUserStats returns all user stats.
      POST
    • GetUserByUsername gets a user by username.
      GET
    • GetUser gets a user by name.
      GET
    • DeleteUser deletes a user.
      DELETE
    • ListUserAccessTokens returns a list of access tokens for a user.
      GET
    • CreateUserAccessToken creates a new access token for a user.
      POST
    • DeleteUserAccessToken deletes an access token for a user.
      DELETE
    • GetUserSetting gets the setting of a user.
      GET
    • GetUserStats returns the stats of a user.
      GET
    • ListShortcuts returns a list of shortcuts for a user.
      GET
    • CreateShortcut creates a new shortcut for a user.
      POST
    • DeleteShortcut deletes a shortcut for a user.
      DELETE
    • UpdateShortcut updates a shortcut for a user.
      PATCH
    • UpdateUserSetting updates the setting of a user.
      PATCH
    • UpdateUser updates a user.
      PATCH
    • GetUserAvatarBinary gets the avatar of a user.
      GET
  • WebhookService
    • ListWebhooks returns a list of webhooks.
    • CreateWebhook creates a new webhook.
    • GetWebhook returns a webhook by id.
    • DeleteWebhook deletes a webhook by id.
    • UpdateWebhook updates a webhook.
  • WorkspaceService
    • GetWorkspaceProfile returns the workspace profile.
  • WorkspaceSettingService
    • GetWorkspaceSetting returns the setting by name.
    • SetWorkspaceSetting updates the setting.
  • ActivityService
    • GetActivity returns the activity with the given id.
  1. UserService

GetUserByUsername gets a user by username.

GET
/api/v1/users:username

请求参数

Query 参数
username
string 
可选
The username of the user.

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/users:username'

返回响应

🟢200成功
application/json
A successful response.
Body
name
string 
可选
The name of the user.
Format: users/{id}, id is the system generated auto-incremented id.
role
enum<string> 
可选
枚举值:
ROLE_UNSPECIFIEDHOSTADMINUSER
默认值:
ROLE_UNSPECIFIED
username
string 
可选
email
string 
可选
nickname
string 
可选
avatarUrl
string 
可选
description
string 
可选
password
string 
可选
state
enum<string> 
可选
枚举值:
STATE_UNSPECIFIEDNORMALARCHIVED
默认值:
STATE_UNSPECIFIED
createTime
string <date-time>
只读可选
updateTime
string <date-time>
只读可选
示例
{
    "name": "string",
    "role": "ROLE_UNSPECIFIED",
    "username": "string",
    "email": "string",
    "nickname": "string",
    "avatarUrl": "string",
    "description": "string",
    "password": "string",
    "state": "STATE_UNSPECIFIED",
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z"
}
🔴500服务器错误
修改于 2025-03-15 17:43:05
上一页
ListAllUserStats returns all user stats.
下一页
GetUser gets a user by name.
Built with