Workspace

Server

Download schema

获取collaboration · notifications

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/collaboration/notifications

获取collaboration · notifications › Responses

请求成功

CollaborationNotificationsResponse

CollaborationNotification[] · required

unreadCount

number · required

GET/v1/collaboration/notifications

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/collaboration/notifications

Example Responses

{
  "notifications": [
    {
      "id": "id",
      "workspaceId": "workspaceId",
      "kind": "mention",
      "sourceKey": "sourceKey",
      "conversationId": "conversationId",
      "sessionId": "sessionId",
      "workObjectId": "workObjectId",
      "workObjectTitle": "workObjectTitle",
      "commentId": "commentId",
      "commentPreview": "commentPreview",
      "actorUserId": "actorUserId",
      "actorDisplayName": "actorDisplayName",
      "actorAvatarURL": "actorAvatarURL",
      "readAt": "readAt",
      "createdAt": "createdAt"
    }
  ],
  "unreadCount": 0
}

json

application/json

更新collaboration · notifications

PATCH

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/collaboration/notifications

更新collaboration · notifications › Request Body

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: all
	type = object · requires: notificationIds

Properties for Variant 1:

all

boolean · const · required

Const value:

更新collaboration · notifications › Responses

请求成功

MarkCollaborationNotificationsReadResponse

updated

number · required

unreadCount

number · required

获取invitations · invitationToken

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/invitations/{invitationToken}

获取invitations · invitationToken › path Parameters

invitationToken

string · required

获取invitations · invitationToken › Responses

请求成功

GenericResponse

创建或执行invitations · invitationToken · accept

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/invitations/{invitationToken}/accept

创建或执行invitations · invitationToken · accept › path Parameters

invitationToken

string · required

创建或执行invitations · invitationToken · accept › Request Body

GenericRequest

创建或执行invitations · invitationToken · accept › Responses

请求成功

GenericResponse

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/invitations/{invitationToken}/login-intent

invitationToken

string · required

InvitationLoginIntentRequest

email

string · required

请求成功

InvitationLoginIntentResponse

workspaceName

string · required

invitedEmail

string · required

contentPermission

WorkspaceContentPermission · enum · required

内容协作权限独立于组织管理角色；view 仍可在场、查看与评论。

Enum values:

edit

view

expiresAt

ISO8601Timestamp · required

projectId

Identifier

projectName

string

创建或执行workspace · invitations

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workspace/invitations

创建或执行workspace · invitations › Request Body

CreateWorkspaceInvitationRequest

email

string · required

accessRole

string · enum · required

Enum values:

admin

member

contentPermission

WorkspaceContentPermission · enum · required

内容协作权限独立于组织管理角色；view 仍可在场、查看与评论。

Enum values:

edit

view

jobRole

JobRole · enum · required

Enum values:

product

engineering

design

other

projectId

Identifier

创建或执行workspace · invitations › Responses

请求成功

CreateWorkspaceInvitationResponse

WorkspaceInvitation · required

inviteURL

string · required

delivery

string · enum · required

Enum values:

link

POST/v1/workspace/invitations

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/workspace/invitations \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "email",
  "accessRole": "admin",
  "contentPermission": "edit",
  "jobRole": "product",
  "projectId": "projectId"
}'

Example Request Body

{
  "email": "email",
  "accessRole": "admin",
  "contentPermission": "edit",
  "jobRole": "product",
  "projectId": "projectId"
}

json

Example Responses

{
  "invitation": {
    "id": "id",
    "workspaceId": "workspaceId",
    "email": "email",
    "accessRole": "admin",
    "contentPermission": "edit",
    "jobRole": "product",
    "projectId": "projectId",
    "status": "pending",
    "invitedByUserId": "invitedByUserId",
    "acceptedByUserId": "acceptedByUserId",
    "expiresAt": "expiresAt",
    "acceptedAt": "acceptedAt",
    "revokedAt": "revokedAt",
    "createdAt": "createdAt",
    "updatedAt": "updatedAt"
  },
  "inviteURL": "inviteURL",
  "delivery": "email"
}

json

application/json

删除workspace · invitations · invitationId

DELETE

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workspace/invitations/{invitationId}

删除workspace · invitations · invitationId › path Parameters

invitationId

string · required

删除workspace · invitations · invitationId › Responses

删除成功

No data returned

创建或执行workspace · invitations · invitationId · resend

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workspace/invitations/{invitationId}/resend

创建或执行workspace · invitations · invitationId · resend › path Parameters

invitationId

string · required

创建或执行workspace · invitations · invitationId · resend › Request Body

GenericRequest

创建或执行workspace · invitations · invitationId · resend › Responses

请求成功

GenericResponse

获取workspace · members

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workspace/members

获取workspace · members › Responses

请求成功

WorkspaceMembersResponse

WorkspaceMember[] · required

WorkspaceInvitation[] · required

GET/v1/workspace/members

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/workspace/members

Example Responses

{
  "members": [
    {
      "userId": "userId",
      "displayName": "displayName",
      "email": "email",
      "avatarURL": "avatarURL",
      "accessRole": "owner",
      "contentPermission": "edit",
      "jobRole": "product",
      "joinedAt": "joinedAt",
      "lastSeenAt": "lastSeenAt",
      "online": true,
      "presencePage": "presencePage",
      "viewingWorkObjectId": "viewingWorkObjectId"
    }
  ],
  "invitations": [
    {
      "id": "id",
      "workspaceId": "workspaceId",
      "email": "email",
      "accessRole": "admin",
      "contentPermission": "edit",
      "jobRole": "product",
      "projectId": "projectId",
      "status": "pending",
      "invitedByUserId": "invitedByUserId",
      "acceptedByUserId": "acceptedByUserId",
      "expiresAt": "expiresAt",
      "acceptedAt": "acceptedAt",
      "revokedAt": "revokedAt",
      "createdAt": "createdAt",
      "updatedAt": "updatedAt"
    }
  ]
}

json

application/json

删除workspace · members · userId

DELETE

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workspace/members/{userId}

删除workspace · members · userId › path Parameters

userId

string · required

删除workspace · members · userId › Responses

删除成功

No data returned

更新workspace · members · userId

PATCH

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workspace/members/{userId}

更新workspace · members · userId › path Parameters

userId

string · required

更新workspace · members · userId › Request Body

GenericRequest

更新workspace · members · userId › Responses

请求成功

GenericResponse

创建或执行workspace · presence

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workspace/presence

创建或执行workspace · presence › Request Body

GenericRequest

创建或执行workspace · presence › Responses

请求成功

GenericResponse

创建或执行workspaces · workspaceId · switch

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/workspaces/{workspaceId}/switch

创建或执行workspaces · workspaceId · switch › path Parameters

workspaceId

string · required

创建或执行workspaces · workspaceId · switch › Request Body

GenericRequest

创建或执行workspaces · workspaceId · switch › Responses

请求成功

GenericResponse

Integrations Reviews

Workspace

获取collaboration · notifications

获取collaboration · notifications › Responses

更新collaboration · notifications

更新collaboration · notifications › Request Body

Decision Table

更新collaboration · notifications › Responses

获取invitations · invitationToken

获取invitations · invitationToken › path Parameters

获取invitations · invitationToken › Responses

创建或执行invitations · invitationToken · accept

创建或执行invitations · invitationToken · accept › path Parameters

创建或执行invitations · invitationToken · accept › Request Body

创建或执行invitations · invitationToken · accept › Responses

创建或执行invitations · invitationToken · login intent

创建或执行invitations · invitationToken · login intent › path Parameters

创建或执行invitations · invitationToken · login intent › Request Body

创建或执行invitations · invitationToken · login intent › Responses

创建或执行workspace · invitations

创建或执行workspace · invitations › Request Body

创建或执行workspace · invitations › Responses

删除workspace · invitations · invitationId

删除workspace · invitations · invitationId › path Parameters

删除workspace · invitations · invitationId › Responses

创建或执行workspace · invitations · invitationId · resend

创建或执行workspace · invitations · invitationId · resend › path Parameters

创建或执行workspace · invitations · invitationId · resend › Request Body

创建或执行workspace · invitations · invitationId · resend › Responses

获取workspace · members

获取workspace · members › Responses

删除workspace · members · userId

删除workspace · members · userId › path Parameters

删除workspace · members · userId › Responses

更新workspace · members · userId

更新workspace · members · userId › path Parameters

更新workspace · members · userId › Request Body

更新workspace · members · userId › Responses

创建或执行workspace · presence

创建或执行workspace · presence › Request Body

创建或执行workspace · presence › Responses

创建或执行workspaces · workspaceId · switch

创建或执行workspaces · workspaceId · switch › path Parameters

创建或执行workspaces · workspaceId · switch › Request Body

创建或执行workspaces · workspaceId · switch › Responses