Microboard.Developers

API

Developer API

The Developer API allows you to programmatically interact with boards and their items. All API endpoints are prefixed with /api/v1/developers.

Authentication

All API requests must include an API key in the X-API-Key header. You can obtain an API key through the API Keys Management endpoints.

API Keys Management

Create a new API Key

POST/api/v1/developers/api-keys

Create a new API key.

Request Body

PropTypeDefault
name
string
-

Responses

API key created successfully

{
  "id": "123",
  "key": "mk_abc123...",
  "name": "My API Key",
  "createdAt": "2024-01-01T00:00:00Z",
  "lastUsedAt": null,
  "message": "⚠️ Save this API key securely. It won't be shown again."
}

List api keys

GET/api/v1/developers/api-keys

List all API keys for the authenticated user.

Responses

Successfully retrieved API keys

{
  "id": "123",
  "userId": 456,
  "name": "My API Key",
  "createdAt": "2024-01-01T00:00:00Z",
  "lastUsedAt": "2024-01-02T00:00:00Z",
  "message": "For security, the API key is hidden. Generate a new one if needed."
}

Revoke api key

DELETE/api/v1/developers/api-keys/{keyId}

Revoke a specific API key.

Responses

API key revoked successfully

Board Items Operations

All board operations require a valid API key in the X-API-Key header.

List items in a board

GET/api/v1/developers/boards/{boardId}/items

List all items in a board.

Responses

Successfully retrieved board items

[
  {
      "id": "123",
      "type": "shape",
      "x": 100,
      "y": 100,
      "width": 200,
      "height": 150,
      "content": {
          "shapeType": "Rectangle",
          "backgroundColor": "rgb(255, 255, 255)",
          "borderColor": "rgb(0, 0, 0)",
          "borderStyle": "solid",
          "borderWidth": 1,
          "text": "Hello World"
      }
  }
]

Get item from a board

GET/api/v1/developers/boards/{boardId}/items/{itemId}

Get a specific item from a board.

Responses

Successfully retrieved item

{
  "id": "123",
  "type": "shape",
  "x": 100,
  "y": 100,
  "width": 200,
  "height": 150,
  "content": {
      "shapeType": "Rectangle",
      "backgroundColor": "rgb(255, 255, 255)",
      "borderColor": "rgb(0, 0, 0)",
      "borderStyle": "solid",
      "borderWidth": 1,
      "text": "Hello World"
  }
}

Create item

POST/api/v1/developers/boards/{boardId}/items

Create a new item in a board.

Request Body

PropTypeDefault
type
"Sticker" | "Shape" | "Drawing" | "Frame" | "RichText"
-
position
{"x": number; "y": "number"}
{"x": 0, "y": 0}
size
object
-
style
object
-
text
string
" "
shapeType
string
Rectangle

Responses

Item created successfully

{
  "id": "123",
  "type": "shape",
  "x": 100,
  "y": 100,
  "width": 200,
  "height": 150,
  "content": {
      "shapeType": "Rectangle",
      "backgroundColor": "rgb(255, 255, 255)",
      "borderColor": "rgb(0, 0, 0)",
      "borderStyle": "solid",
      "borderWidth": 1,
      "text": "Hello World"
  }
}

Update item

PATCH/api/v1/developers/boards/{boardId}/items/{itemId}

Update a specific item in a board.

Request Body

PropTypeDefault
position
object
-
style
object
-
text
object
-

Responses

Item updated successfully

{
  "id": "123",
  "type": "shape",
  "x": 150,
  "y": 150,
  "width": 200,
  "height": 150,
  "content": {
      "shapeType": "Rectangle",
      "backgroundColor": "rgb(200, 200, 200)",
      "borderColor": "rgb(0, 0, 0)",
      "borderStyle": "solid",
      "borderWidth": 1,
      "text": "Updated text"
  }
}

Delete item

DELETE/api/v1/developers/boards/{boardId}/items/{itemId}

Delete a specific item from a board.

Responses

Item deleted successfully

Batch update

POST/api/v1/developers/boards/{boardId}/items/batch

Perform multiple operations on board items in a single request.

Request Body

PropTypeDefault
operations
array
-

Responses

Batch operations completed successfully

Array of updated board items

Setup refresh

POST/api/v1/developers/boards/{boardId}/items/{itemId}/refresh

Configure refresh settings for a specific item.

Request Body

PropTypeDefault
url
string
-
interval
number
-

Responses

Refresh configuration updated successfully

Updated item object with refresh configuration

Types Reference

Item Types

  • Shape: Basic shapes like rectangles, circles, etc.
  • Sticker: Sticky notes with text
  • Frame: Container that can hold other items
  • Drawing: Free-form drawings

Shape Types

  • Rectangle
  • RoundedRectangle
  • Circle
  • Triangle
  • Rhombus
  • SpeachBubble
  • Parallelogram
  • Star
  • ArrowRight
  • ArrowLeft
  • ArrowLeftRight
  • Pentagon
  • Octagon
  • Hexagon
  • PredefinedProcess
  • Trapezoid
  • Cloud
  • Cross
  • Cylinder
  • BracesRight
  • BracesLeft

Frame Types

  • Custom
  • Frame16x9
  • Frame4x3
  • A4
  • Letter
  • Frame1x1

Border Styles

  • solid
  • dot
  • dash
  • longDash
  • dotDash
  • tripleDotDash
  • looseDoubleDotDash

Previous

Overview

Next

Authentication

On this page