Dev Tools Hero
DEVELOPER CENTER

Workspace API Reference

Detailed integration schemas and API controls for SoftBridge Workspace products.

Workspace Bookmarks API

SoftBridge Workspace Bookmarks provides link organization, cataloging, and quick-access directory management for teams and individuals. Bookmarks are interconnected with documents and tasks.

Free Tier Limit 10 bookmarks total
Premium Tier Limit Unlimited

Authentication Required

Pass the Firebase ID Token in the Authorization header.

Authorization: Bearer <firebase_id_token>

Endpoints

POST /workspace/bookmarks Create Bookmark

Creates a new bookmark. Bookmarks can be linked to other workspace documents or tasks.

Request Body (JSON)
{
  "title": "MDN Web Docs",
  "url": "https://developer.mozilla.org",
  "description": "Resources for developers, by developers.",
  "tags": ["documentation", "web", "javascript"],
  "category": "Development",
  "linkedDocs": [],
  "linkedTasks": [],
  "isPublic": false
}
Response (201 Created)
{
  "success": true,
  "message": "Bookmark created successfully",
  "data": {
    "_id": "64d0e1...",
    "uid": "user_uid_123",
    "title": "MDN Web Docs",
    "url": "https://developer.mozilla.org",
    "description": "Resources for developers, by developers.",
    "tags": ["documentation", "web", "javascript"],
    "category": "Development",
    "linkedDocs": [],
    "linkedTasks": [],
    "isPublic": false,
    "createdAt": "2026-06-28T19:00:00.000Z"
  }
}
GET /workspace/bookmarks List Bookmarks

Lists all bookmarks owned by the authenticated user.

GET /workspace/bookmarks/:id Get Bookmark Details

Retrieves details of a specific bookmark by its ID.

PUT /workspace/bookmarks/:id Update Bookmark

Updates details of an existing bookmark.

DELETE /workspace/bookmarks/:id Delete Bookmark

Removes a bookmark from the workspace.

Workspace Docs API

SoftBridge Workspace Docs is a collaborative rich-text / markdown document editor application. It allows users to write personal journals, collaborate on meeting notes, and structure enterprise wikis. Docs are interconnected with sheets, forms, tasks, bookmarks, whiteboards, and calendar events.

Free Tier Limit 3 documents total
Premium Tier Limit Unlimited

Authentication Required

Pass the Firebase ID Token in the Authorization header.

Authorization: Bearer <firebase_id_token>

Endpoints

POST /workspace/docs Create Document

Creates a new document with optional metadata and workspace resource links.

Request Body (JSON)
{
  "title": "Project Kickoff Notes",
  "content": "# Kickoff meeting\nDiscussion on SoftBridge Workspace components.",
  "linkedSheets": [],
  "linkedForms": [],
  "linkedTasks": [],
  "linkedEvents": ["evt_12345"],
  "collaborators": [
    {
      "uid": "collab_uid_abc",
      "email": "[email protected]",
      "role": "editor"
    }
  ],
  "isPublic": false
}
Response (201 Created)
{
  "success": true,
  "message": "Document created successfully",
  "data": {
    "_id": "64d0a1...",
    "uid": "user_uid_123",
    "title": "Project Kickoff Notes",
    "content": "# Kickoff meeting...",
    "linkedSheets": [],
    "linkedForms": [],
    "linkedTasks": [],
    "linkedEvents": ["evt_12345"],
    "collaborators": [...],
    "isPublic": false,
    "createdAt": "2026-06-28T19:00:00.000Z",
    "updatedAt": "2026-06-28T19:00:00.000Z"
  }
}
GET /workspace/docs List Documents

Lists all documents owned by the user or where the user is a collaborator.

GET /workspace/docs/:id Get Document Details

Retrieves details of a specific document. Accessible if public or if the requester has owner/collaborator privileges.

PUT /workspace/docs/:id Update Document

Updates the content, title, or settings of an existing document.

DELETE /workspace/docs/:id Delete Document

Deletes a document. Only the owner can delete.

POST /workspace/docs/:id/link Manage Connections

Explicitly link or unlink documents to other workspace resources.

Request Body
{
  "targetType": "sheet", 
  "targetId": "64d0b2...", 
  "action": "add" 
}
Note: targetType can be sheet, form, task, or event. action can be add or remove.

Workspace Tasks & Projects API

SoftBridge Workspace Tasks provides project planning, board management, and task scheduling tools. It helps B2B teams manage development sprints and B2C users manage daily personal task lists. Tasks are interconnected with sheets, forms, docs, bookmarks, whiteboards, and calendars.

Free Tier Limit 10 tasks total
Premium Tier Limit Unlimited

Authentication Required

Pass the Firebase ID Token in the Authorization header.

Authorization: Bearer <firebase_id_token>

Endpoints

POST /workspace/tasks Create Task

Creates a new task in a project workspace.

Request Body (JSON)
{
  "projectId": "sb-workspace-launch",
  "projectName": "SB Workspace Launch Sprint",
  "title": "Implement Docs and Tasks Routers",
  "description": "Create the new endpoints and models for interconnected apps.",
  "status": "in_progress",
  "priority": "high",
  "dueDate": "2026-07-05T18:00:00.000Z",
  "assignees": [
    {
      "uid": "user_uid_123",
      "email": "[email protected]"
    }
  ]
}
Response (201 Created)
{
  "success": true,
  "message": "Task created successfully",
  "data": {
    "_id": "64d0c1...",
    "uid": "creator_uid",
    "projectId": "sb-workspace-launch",
    "projectName": "SB Workspace Launch Sprint",
    "title": "Implement Docs and Tasks Routers",
    "status": "in_progress",
    "priority": "high",
    "dueDate": "2026-07-05T18:00:00.000Z",
    "assignees": [...],
    "linkedDocs": [],
    "linkedSheets": [],
    "linkedForms": [],
    "linkedEvents": [],
    "createdAt": "2026-06-28T19:00:00.000Z"
  }
}
GET /workspace/tasks List Tasks

Lists all tasks. Supports filtering via optional query parameters.

Query Parameters (Optional)
  • projectId: Filter tasks by project (e.g. ?projectId=sb-workspace-launch)
  • status: Filter by status (todo, in_progress, completed, archived)
  • priority: Filter by priority (low, medium, high)
GET /workspace/tasks/:id Get Task Details

Retrieves details of a specific task.

PUT /workspace/tasks/:id Update Task

Updates fields of an existing task.

DELETE /workspace/tasks/:id Delete Task

Deletes a task from the board.

POST /workspace/tasks/:id/link Manage Connections

Link or unlink a task to files, documents, sheets, forms, or calendar events.

Request Body
{
  "targetType": "doc",
  "targetId": "64d0a1...",
  "action": "add"
}
Note: targetType can be doc, sheet, form, event, or file. action can be add or remove.

Form Submission Task Automation

Workspace Forms can be configured to automatically spawn tasks when a user submits a response. To enable this, configure the taskIntegration object on your form:

{
  "taskIntegration": {
    "enabled": true,
    "projectId": "lead-generation-project",
    "projectName": "Marketing Leads",
    "taskTitlePrefix": "New Response from"
  }
}

When submitted, a task will automatically be created containing the full response breakdown in its description.

Workspace Whiteboard & Draw API

SoftBridge Workspace Whiteboard provides element-based layout drawing, SVG paths representation, and flow chart sketching for B2B collaboration and B2C visual drafting. Whiteboards are interconnected with documents and tasks.

Free Tier Limit 1 whiteboard total
Premium Tier Limit Unlimited

Authentication Required

Pass the Firebase ID Token in the Authorization header.

Authorization: Bearer <firebase_id_token>

Endpoints

POST /workspace/whiteboard Create Whiteboard

Creates a new collaborative drawing whiteboard.

Request Body (JSON)
{
  "title": "System Architecture Draft",
  "elements": [
    {
      "id": "node-1",
      "type": "rectangle",
      "x": 100,
      "y": 150,
      "width": 120,
      "height": 60,
      "stroke": "#000000",
      "fill": "#ffffff",
      "text": "API Server"
    }
  ],
  "collaborators": [
    {
      "uid": "collab_uid_xyz",
      "email": "[email protected]",
      "role": "editor"
    }
  ],
  "isPublic": false
}
Response (201 Created)
{
  "success": true,
  "message": "Whiteboard created successfully",
  "data": {
    "_id": "64d0f1...",
    "uid": "user_uid_123",
    "title": "System Architecture Draft",
    "elements": [...],
    "collaborators": [...],
    "isPublic": false,
    "createdAt": "2026-06-28T19:00:00.000Z"
  }
}
GET /workspace/whiteboard List Whiteboards

Lists all whiteboards owned by the user or where the user is a collaborator.

GET /workspace/whiteboard/:id Get Whiteboard Details

Retrieves element details of a specific whiteboard.

PUT /workspace/whiteboard/:id Update Whiteboard

Updates elements, layouts, collaborators or settings of a whiteboard.

DELETE /workspace/whiteboard/:id Delete Whiteboard

Permanently deletes a whiteboard.