version not set

OAS 2.0

api/v1/activity_service.proto

Base URL

Client Libraries

Shell

Ruby

Node.js

PHP

Python

cURL Shell

ActivityService

Endpoints

GET/api/v1/activities/{id}

GetActivity returns the activity with the given id.

Path Parameters

id
required

Responses

200
default

GET/api/v1/activities/{id}

Shell cURL

Show Schema

{
  "code": 1,
  "message": "…",
  "details": [
    null
  ]
}

UserService

Endpoints

GET/api/v1/users POST/api/v1/users GET/api/v1/users:search GET/api/v1/{name}DELETE/api/v1/{name}GET/api/v1/{name}/access_tokens POST/api/v1/{name}/access_tokens DELETE/api/v1/{name}/access_tokens/{accessToken}GET/api/v1/{name}/setting PATCH/api/v1/{setting.name}PATCH/api/v1/{user.name}

AuthService

Endpoints

POST/api/v1/auth/signin POST/api/v1/auth/signin/sso POST/api/v1/auth/signout POST/api/v1/auth/signup POST/api/v1/auth/status

IdentityProviderService

Endpoints

GET/api/v1/identityProviders POST/api/v1/identityProviders PATCH/api/v1/{identityProvider.name}GET/api/v1/{name_1}DELETE/api/v1/{name_1}

InboxService

Endpoints

GET/api/v1/inboxes PATCH/api/v1/{inbox.name}DELETE/api/v1/{name_2}

MarkdownService

Endpoints

GET/api/v1/markdown/link:metadata POST/api/v1/markdown/parse POST/api/v1/markdown:restore

ResourceService

Endpoints

GET/api/v1/resources POST/api/v1/resources GET/api/v1/resources:search GET/api/v1/{name_2}DELETE/api/v1/{name_3}PATCH/api/v1/{resource.name}

MemoService

Endpoints

GET/api/v1/memos POST/api/v1/memos GET/api/v1/memos/stats POST/api/v1/memos:export GET/api/v1/memos:search DELETE/api/v1/reactions/{reactionId}PATCH/api/v1/{memo.name}GET/api/v1/{name_3}DELETE/api/v1/{name_4}GET/api/v1/{name}/comments POST/api/v1/{name}/comments GET/api/v1/{name}/reactions POST/api/v1/{name}/reactions GET/api/v1/{name}/relations PATCH/api/v1/{name}/relations GET/api/v1/{name}/resources PATCH/api/v1/{name}/resources

TagService

Endpoints

GET/api/v1/tags DELETE/api/v1/tags POST/api/v1/tags GET/api/v1/tags/suggestion POST/api/v1/tags:batchUpsert PATCH/api/v1/tags:rename

WebhookService

Endpoints

GET/api/v1/webhooks POST/api/v1/webhooks GET/api/v1/webhooks/{id}DELETE/api/v1/webhooks/{id}PATCH/api/v1/webhooks/{webhook.id}

WorkspaceService

Endpoints

GET/api/v1/workspace/profile

GetWorkspaceProfile returns the workspace profile.

Responses

200
default

GET/api/v1/workspace/profile

Shell cURL

Show Schema

{
  "code": 1,
  "message": "…",
  "details": [
    null
  ]
}

WorkspaceSettingService

Endpoints

GET/api/v1/workspace/settings GET/api/v1/workspace/{name}PATCH/api/v1/workspace/{setting.name}

api/v1/activity_service.proto

ActivityService​ # Copy link to "ActivityService"

GetActivity returns the activity with the given id.​ # Copy link to "GetActivity returns the activity with the given id."

UserService​ # Copy link to "UserService"

AuthService​ # Copy link to "AuthService"

IdentityProviderService​ # Copy link to "IdentityProviderService"

InboxService​ # Copy link to "InboxService"

MarkdownService​ # Copy link to "MarkdownService"

ResourceService​ # Copy link to "ResourceService"

MemoService​ # Copy link to "MemoService"

TagService​ # Copy link to "TagService"

WebhookService​ # Copy link to "WebhookService"

WorkspaceService​ # Copy link to "WorkspaceService"

GetWorkspaceProfile returns the workspace profile.​ # Copy link to "GetWorkspaceProfile returns the workspace profile."

WorkspaceSettingService​ # Copy link to "WorkspaceSettingService"

ActivityService

GetActivity returns the activity with the given id.

UserService

AuthService

IdentityProviderService

InboxService

MarkdownService

ResourceService

MemoService

TagService

WebhookService

WorkspaceService

GetWorkspaceProfile returns the workspace profile.

WorkspaceSettingService