- AuthService
- IdentityProviderService
- InboxService
- MarkdownService
- MemoService
- ListMemos lists memos with pagination and filter.GET
- CreateMemo creates a memo.POST
- DeleteMemoReaction deletes a reaction for a memo.DELETE
- UpdateMemo updates a memo.PATCH
- GetMemo gets a memo.GET
- DeleteMemo deletes a memo.DELETE
- ListMemoComments lists comments for a memo.GET
- CreateMemoComment creates a comment for a memo.POST
- ListMemoReactions lists reactions for a memo.GET
- UpsertMemoReaction upserts a reaction for a memo.POST
- ListMemoRelations lists relations for a memo.GET
- SetMemoRelations sets relations for a memo.PATCH
- ListMemoResources lists resources for a memo.GET
- SetMemoResources sets resources for a memo.PATCH
- ListMemos lists memos with pagination and filter.GET
- DeleteMemoTag deletes a tag for a memo.DELETE
- RenameMemoTag renames a tag for a memo.PATCH
- ResourceService
- UserService
- ListUsers returns a list of users.
- CreateUser creates a new user.
- ListAllUserStats returns all user stats.
- GetUserByUsername gets a user by username.
- GetUser gets a user by name.
- DeleteUser deletes a user.
- ListUserAccessTokens returns a list of access tokens for a user.
- CreateUserAccessToken creates a new access token for a user.
- DeleteUserAccessToken deletes an access token for a user.
- GetUserSetting gets the setting of a user.
- GetUserStats returns the stats of a user.
- ListShortcuts returns a list of shortcuts for a user.
- CreateShortcut creates a new shortcut for a user.
- DeleteShortcut deletes a shortcut for a user.
- UpdateShortcut updates a shortcut for a user.
- UpdateUserSetting updates the setting of a user.
- UpdateUser updates a user.
- GetUserAvatarBinary gets the avatar of a user.
- WebhookService
- WorkspaceService
- WorkspaceSettingService
- ActivityService
ListMemos lists memos with pagination and filter.
GET
/api/v1/memos
请求参数
Query 参数
parent
string
可选
If not specified or
users/-, it will list all memos.pageSize
integer <int32>
可选
pageToken
string
可选
ListMemos call.
Provide this to retrieve the subsequent page.
state
enum<string>
可选
Default to
NORMAL. Set to ARCHIVED to list archived memos.枚举值:
STATE_UNSPECIFIEDNORMALARCHIVED
默认值:
STATE_UNSPECIFIED
sort
string
可选
Default to display_time.
direction
enum<string>
可选
Default to DESC.
枚举值:
DIRECTION_UNSPECIFIEDASCDESC
默认值:
DIRECTION_UNSPECIFIED
filter
string
可选
Refer to
Shortcut.filter.oldFilter
string
可选
Format: "creator == 'users/{user}' && visibilities == ['PUBLIC', 'PROTECTED']"
示例代码
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/memos'返回响应
🟢200成功
application/json
Body
memos
array[object (apiv1Memo) {18}]
可选
name
string
只读可选
Format: memos/{memo}, memo is the user defined id or uuid.
state
enum<string>
可选
枚举值:
STATE_UNSPECIFIEDNORMALARCHIVED
默认值:
STATE_UNSPECIFIED
creator
string
The name of the creator.
Format: users/{user}
createTime
string <date-time>
可选
updateTime
string <date-time>
可选
displayTime
string <date-time>
可选
content
string
可选
nodes
array[object (v1Node) {32}]
只读可选
visibility
enum<string>
可选
枚举值:
VISIBILITY_UNSPECIFIEDPRIVATEPROTECTEDPUBLIC
默认值:
VISIBILITY_UNSPECIFIED
tags
array[string]
只读可选
pinned
boolean
可选
resources
array[object (v1Resource) {8}]
可选
relations
array[object (v1MemoRelation) {3}]
可选
reactions
array[object (v1Reaction) {4}]
只读可选
property
object (v1MemoProperty)
可选
parent
string
The name of the parent memo.
Format: memos/{id}
snippet
string
只读可选
location
object (apiv1Location)
可选
nextPageToken
string
可选
page_token to retrieve the next page.
If this field is omitted, there are no subsequent pages.
示例
{
"memos": [
{
"name": "string",
"state": "STATE_UNSPECIFIED",
"creator": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"displayTime": "2019-08-24T14:15:22Z",
"content": "string",
"nodes": [
{
"type": "NODE_UNSPECIFIED",
"lineBreakNode": {},
"paragraphNode": {
"children": [
{}
]
},
"codeBlockNode": {
"language": "string",
"content": "string"
},
"headingNode": {
"level": 0,
"children": [
{}
]
},
"horizontalRuleNode": {
"symbol": "string"
},
"blockquoteNode": {
"children": [
{}
]
},
"listNode": {
"kind": "KIND_UNSPECIFIED",
"indent": 0,
"children": [
{}
]
},
"orderedListItemNode": {
"number": "string",
"indent": 0,
"children": [
{}
]
},
"unorderedListItemNode": {
"symbol": "string",
"indent": 0,
"children": [
{}
]
},
"taskListItemNode": {
"symbol": "string",
"indent": 0,
"complete": true,
"children": [
{}
]
},
"mathBlockNode": {
"content": "string"
},
"tableNode": {
"header": [
{}
],
"delimiter": [
"string"
],
"rows": [
{
"cells": [
{}
]
}
]
},
"embeddedContentNode": {
"resourceName": "string",
"params": "string"
},
"textNode": {
"content": "string"
},
"boldNode": {
"symbol": "string",
"children": [
{}
]
},
"italicNode": {
"symbol": "string",
"content": "string"
},
"boldItalicNode": {
"symbol": "string",
"content": "string"
},
"codeNode": {
"content": "string"
},
"imageNode": {
"altText": "string",
"url": "string"
},
"linkNode": {
"text": "string",
"url": "string"
},
"autoLinkNode": {
"url": "string",
"isRawText": true
},
"tagNode": {
"content": "string"
},
"strikethroughNode": {
"content": "string"
},
"escapingCharacterNode": {
"symbol": "string"
},
"mathNode": {
"content": "string"
},
"highlightNode": {
"content": "string"
},
"subscriptNode": {
"content": "string"
},
"superscriptNode": {
"content": "string"
},
"referencedContentNode": {
"resourceName": "string",
"params": "string"
},
"spoilerNode": {
"content": "string"
},
"htmlElementNode": {
"tagName": "string",
"attributes": {
"property1": "string",
"property2": "string"
}
}
}
],
"visibility": "VISIBILITY_UNSPECIFIED",
"tags": [
"string"
],
"pinned": true,
"resources": [
{
"name": "string",
"createTime": "2019-08-24T14:15:22Z",
"filename": "string",
"content": "string",
"externalLink": "string",
"type": "string",
"size": "string",
"memo": "string"
}
],
"relations": [
{
"memo": {
"name": "string",
"uid": "string",
"snippet": "string"
},
"relatedMemo": {
"name": "string",
"uid": "string",
"snippet": "string"
},
"type": "TYPE_UNSPECIFIED"
}
],
"reactions": [
{
"id": 0,
"creator": "string",
"contentId": "string",
"reactionType": "string"
}
],
"property": {
"hasLink": true,
"hasTaskList": true,
"hasCode": true,
"hasIncompleteTasks": true
},
"parent": "string",
"snippet": "string",
"location": {
"placeholder": "string",
"latitude": 0,
"longitude": 0
}
}
],
"nextPageToken": "string"
}🔴500服务器错误
修改于 2025-03-15 17:43:05