Attachments List

Get list of attachments in a surface.

Details

Path: /v1/workspaces/<workspace_id>/elements/<surface_type>/<surface_id>/attachments
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
surface_type string Required The type of the surface element Allowed values:
 - "documents"
 - "notes"
 - "images"
 - "browsers"
 - "videos"
surface_id string Required The id of the surface element

Response Schema

{
  "type": "object",
  "properties": {
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Attachment Create

Create an attachment in the specified surface. You attach the sourceId object defined in the Request Body to the object defined in the API endopint (/<surface_type>/<surface_id>/). In the Workspace, a fading yellow frame is shown around the attached object when this API call is executed.
See more details in the Attachments API page.

Details

Path: /v1/workspaces/<workspace_id>/elements/<surface_type>/<surface_id>/attachments
HTTP Method: POST
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
surface_type string Required The type of the surface element Allowed values:
 - "documents"
 - "notes"
 - "images"
 - "browsers"
 - "videos"
surface_id string Required The id of the surface element

Body

Name Type Required? Default Description
x integer Optional 0
y integer Optional 0
sourceId string Required

Response Schema

{
  "type": "object",
  "properties": {
    "x": {
      "type": "integer",
      "default": 0
    },
    "y": {
      "type": "integer",
      "default": 0
    },
    "source": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      }
    },
    "surface": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Attachments Delete

Delete attachment in a surface. This operation will remove the attachment of the <target_id> object from the /<surface_type>/<surface_id>/ object. In the Workspace, a fading blue frame is shown around the unattached object <target_id> object when this API call is executed.
See more details in the Attachments API page

Details

Path: /v1/workspaces/<workspace_id>/elements/<surface_type>/<surface_id>/attachments/<target_id>
HTTP Method: DELETE
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
surface_type string Required The type of the surface element Allowed values:
 - "documents"
 - "notes"
 - "images"
 - "browsers"
 - "videos"
surface_id string Required The id of the surface element
target_id string Required The id of the target element

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Browsers List

Get list of browsers in the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/browsers
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace

Response Schema

{
  "type": "object",
  "properties": {
    "browsers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "height": {
            "type": "integer"
          },
          "width": {
            "type": "integer"
          },
          "contentWidth": {
            "type": "integer"
          },
          "contentHeight": {
            "type": "integer"
          },
          "url": {
            "type": "string"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Browser Create

Add a browser to the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/browsers
HTTP Method: POST
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace

Body

Name Type Required? Default Description
x integer Optional 0
y integer Optional 0
width integer Optional
height integer Optional
contentWidth integer Optional
contentHeight integer Optional
url string Required
frameless boolean Optional
traits array Optional

Response Schema

{
  "type": "object",
  "properties": {
    "browser": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "height": {
          "type": "integer"
        },
        "width": {
          "type": "integer"
        },
        "contentWidth": {
          "type": "integer"
        },
        "contentHeight": {
          "type": "integer"
        },
        "url": {
          "type": "string"
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Get browser details by Id

Get browser details by Id.

Details

Path: /v1/workspaces/<workspace_id>/elements/browsers/<browser_id>
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
browser_id string Required The Unique ID of the text element

Response Schema

{
  "type": "object",
  "properties": {
    "browser": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "height": {
          "type": "integer"
        },
        "width": {
          "type": "integer"
        },
        "contentWidth": {
          "type": "integer"
        },
        "contentHeight": {
          "type": "integer"
        },
        "url": {
          "type": "string"
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Browser Update

Update the specified browser in the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/browsers/<browser_id>
HTTP Method: PUT
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
browser_id string Required The Unique ID of the text element

Body

Name Type Required? Default Description
x integer Optional 0
y integer Optional 0
width integer Optional
height integer Optional
url string Optional

Response Schema

{
  "type": "object",
  "properties": {
    "browser": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "height": {
          "type": "integer"
        },
        "width": {
          "type": "integer"
        },
        "contentWidth": {
          "type": "integer"
        },
        "contentHeight": {
          "type": "integer"
        },
        "url": {
          "type": "string"
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Browser Delete

Delete the specified browser from the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/browsers/<browser_id>
HTTP Method: DELETE
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
browser_id string Required The Unique ID of the text element

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Canvas List

Get list of canvas in the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/canvas
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace

Response Schema

{
  "type": "object",
  "properties": {
    "canvas": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "507f191e810c19729de860ea"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer"
          },
          "height": {
            "type": "integer"
          },
          "name": {
            "type": "string",
            "example": "Text"
          },
          "borderColor": {
            "type": "string",
            "enum": ["Red", "Yellow", "Green", "Blue"],
            "default": "Red"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "children": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Canvas Create

Create a canvas in the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/canvas
HTTP Method: POST
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace

Body

Name Type Required? Default Description
x integer Optional 0
y integer Optional 0
width integer Optional
height integer Optional
name string Required
borderColor string Optional Red Allowed values:
 - "Red"
 - "Yellow"
 - "Green"
 - "Blue"
traits array Optional

Response Schema

{
  "type": "object",
  "properties": {
    "canvas": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "507f191e810c19729de860ea"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "width": {
          "type": "integer"
        },
        "height": {
          "type": "integer"
        },
        "name": {
          "type": "string",
          "example": "Text"
        },
        "borderColor": {
          "type": "string",
          "enum": ["Red", "Yellow", "Green", "Blue"],
          "default": "Red"
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "children": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Get canvas details by Id

Get canvas details by Id.

Details

Path: /v1/workspaces/<workspace_id>/elements/canvas/<canvas_id>
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
canvas_id string Required The Unique ID of the canvas

Response Schema

{
  "type": "object",
  "properties": {
    "canvas": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "507f191e810c19729de860ea"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "width": {
          "type": "integer"
        },
        "height": {
          "type": "integer"
        },
        "name": {
          "type": "string",
          "example": "Text"
        },
        "borderColor": {
          "type": "string",
          "enum": ["Red", "Yellow", "Green", "Blue"],
          "default": "Red"
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "children": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Canvas Update

Update the specified canvas in the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/canvas/<canvas_id>
HTTP Method: PUT
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
canvas_id string Required The Unique ID of the canvas

Body

Name Type Required? Default Description
name string Optional
borderColor string Optional Red Allowed values:
 - "Red"
 - "Yellow"
 - "Green"
 - "Blue"

Response Schema

{
  "type": "object",
  "properties": {
    "canvas": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "507f191e810c19729de860ea"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "width": {
          "type": "integer"
        },
        "height": {
          "type": "integer"
        },
        "name": {
          "type": "string",
          "example": "Text"
        },
        "borderColor": {
          "type": "string",
          "enum": ["Red", "Yellow", "Green", "Blue"],
          "default": "Red"
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "children": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Canvas Delete

Delete the specified canvas from the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/canvas/<canvas_id>
HTTP Method: DELETE
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
canvas_id string Required The Unique ID of the canvas

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Get objects list in canvas

Get list of the specified type of object in a canvas. If you specify <object_type> as 'images', you will get the list of all the images contained in the specified Canvas.

Details

Path: /v1/workspaces/<workspace_id>/elements/canvas/<canvas_id>/<object_type>
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
canvas_id string Required The Unique ID of the canvas
object_type string Required The type of object details which are placed inside the canvas Allowed values:
 - "documents"
 - "notes"
 - "images"
 - "text"
 - "canvas"
 - "browsers"
 - "strokes"
 - "videos"
 - "grids"

Response Schema

{
  "type": "object",
  "properties": {
    "canvas": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "507f191e810c19729de860ea"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer"
          },
          "height": {
            "type": "integer"
          },
          "name": {
            "type": "string",
            "example": "Text"
          },
          "borderColor": {
            "type": "string",
            "enum": ["Red", "Yellow", "Green", "Blue"],
            "default": "Red"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "children": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "notes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "507f191e810c19729de860ea"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer",
            "example": 560
          },
          "height": {
            "type": "integer",
            "example": 320
          },
          "text": {
            "type": "string",
            "example": "Text"
          },
          "fontWeight": {
            "type": "string",
            "enum": ["normal", "bold"],
            "default": "normal"
          },
          "fontSize": {
            "type": "integer",
            "default": 64
          },
          "textTransform": {
            "type": "string",
            "enum": ["inherit", "uppercase"],
            "default": "inherit"
          },
          "backgroundColor": {
            "type": "string",
            "enum": ["Beige", "Blue", "Gold", "Grey", "Red", "Teal", "Yellow"],
            "default": "Teal"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "scale": {
            "type": "number",
            "default": 1,
            "minimum": 0.5,
            "maximum": 4
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "strokeIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "browsers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "height": {
            "type": "integer"
          },
          "width": {
            "type": "integer"
          },
          "contentWidth": {
            "type": "integer"
          },
          "contentHeight": {
            "type": "integer"
          },
          "url": {
            "type": "string"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "images": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "url": {
            "type": "string"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "scale": {
            "type": "number",
            "default": 1,
            "minimum": 0.5,
            "maximum": 4
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "strokeIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "documents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "type": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "scale": {
            "type": "number",
            "default": 1,
            "minimum": 0.5,
            "maximum": 4
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "strokeIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "text": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer"
          },
          "height": {
            "type": "integer"
          },
          "text": {
            "type": "string",
            "minLength": 1,
            "maxLength": 3000
          },
          "fontFamily": {
            "type": "string",
            "enum": ["Dosis", "Helvetica", "Times New Roman", "Source Code Pro", "Aleo", "Exo 2"],
            "default": "Dosis"
          },
          "fontSize": {
            "type": "integer",
            "default": 64
          },
          "fontColor": {
            "type": "string",
            "default": "#ffffff"
          },
          "fontWeight": {
            "type": "string",
            "enum": ["normal", "bold"],
            "default": "normal"
          },
          "fontStyle": {
            "type": "string",
            "enum": ["normal", "italic"],
            "default": "normal"
          },
          "textTransform": {
            "type": "string",
            "enum": ["inherit", "uppercase"],
            "default": "inherit"
          },
          "backgroundColor": {
            "type": "string",
            "default": "#ea3e35"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "surface": {
            "type": "string",
            "default": null
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "strokes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "penColor": {
            "type": "string",
            "enum": ["White", "Gray", "Yellow", "Red", "Green", "Purple", "Cyan"],
            "default": "White"
          },
          "size": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100
          },
          "brushType": {
            "type": "string",
            "enum": ["Pen", "Eraser"],
            "default": "Pen"
          },
          "points": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "targetId": {
            "type": "string"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "videos": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "507f191e810c19729de860ea"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer"
          },
          "height": {
            "type": "integer"
          },
          "title": {
            "type": "string",
            "example": "Text"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          }
        }
      }
    },
    "grids": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "507f191e810c19729de860ea"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer"
          },
          "height": {
            "type": "integer"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "horizontalMargin": {
            "type": "integer"
          },
          "verticalMargin": {
            "type": "integer"
          },
          "cellWidth": {
            "type": "integer"
          },
          "cellHeight": {
            "type": "integer"
          },
          "rows": {
            "type": "integer"
          },
          "columns": {
            "type": "integer"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "elements": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "row": {
                  "type": "integer"
                },
                "column": {
                  "type": "integer"
                }
              }
            }
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Add Browser to canvas

Add a browser to the canvas.

Details

Path: /v1/workspaces/<workspace_id>/elements/canvas/<canvas_id>/browsers
HTTP Method: POST
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
canvas_id string Required The Unique ID of the canvas

Body

Name Type Required? Default Description
x integer Optional 0
y integer Optional 0
width integer Optional
height integer Optional
contentWidth integer Optional
contentHeight integer Optional
url string Required
frameless boolean Optional
traits array Optional

Response Schema

{
  "type": "object",
  "properties": {
    "browser": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "height": {
          "type": "integer"
        },
        "width": {
          "type": "integer"
        },
        "contentWidth": {
          "type": "integer"
        },
        "contentHeight": {
          "type": "integer"
        },
        "url": {
          "type": "string"
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Add Canvas to canvas

Add a canvas to the canvas.

Details

Path: /v1/workspaces/<workspace_id>/elements/canvas/<canvas_id>/canvas
HTTP Method: POST
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
canvas_id string Required The Unique ID of the canvas

Body

Name Type Required? Default Description
x integer Optional 0
y integer Optional 0
width integer Optional
height integer Optional
name string Required
borderColor string Optional Red Allowed values:
 - "Red"
 - "Yellow"
 - "Green"
 - "Blue"
traits array Optional

Response Schema

{
  "type": "object",
  "properties": {
    "canvas": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "507f191e810c19729de860ea"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "width": {
          "type": "integer"
        },
        "height": {
          "type": "integer"
        },
        "name": {
          "type": "string",
          "example": "Text"
        },
        "borderColor": {
          "type": "string",
          "enum": ["Red", "Yellow", "Green", "Blue"],
          "default": "Red"
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "children": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Get elements in canvas

Get a list of elements in the canvas. The Response Body returns a list of all the elements in the Canvas, grouped by their object type: 'notes, 'browsers', 'images', 'documents', 'text', 'strokes', 'videos' and 'grids'.

Details

Path: /v1/workspaces/<workspace_id>/elements/canvas/<canvas_id>/elements
HTTP Method: GET
Authorization: Bearer Token
Parameters: path query

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
canvas_id string Required The Unique ID of the canvas

Query

Name Type Required? Description
element_type string Optional Get elements types like notes, text, canvas, documents, images, browsers, strokes in canvas

Response Schema

{
  "type": "object",
  "properties": {
    "canvas": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "507f191e810c19729de860ea"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer"
          },
          "height": {
            "type": "integer"
          },
          "name": {
            "type": "string",
            "example": "Text"
          },
          "borderColor": {
            "type": "string",
            "enum": ["Red", "Yellow", "Green", "Blue"],
            "default": "Red"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "children": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "notes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "507f191e810c19729de860ea"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer",
            "example": 560
          },
          "height": {
            "type": "integer",
            "example": 320
          },
          "text": {
            "type": "string",
            "example": "Text"
          },
          "fontWeight": {
            "type": "string",
            "enum": ["normal", "bold"],
            "default": "normal"
          },
          "fontSize": {
            "type": "integer",
            "default": 64
          },
          "textTransform": {
            "type": "string",
            "enum": ["inherit", "uppercase"],
            "default": "inherit"
          },
          "backgroundColor": {
            "type": "string",
            "enum": ["Beige", "Blue", "Gold", "Grey", "Red", "Teal", "Yellow"],
            "default": "Teal"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "scale": {
            "type": "number",
            "default": 1,
            "minimum": 0.5,
            "maximum": 4
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "strokeIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "browsers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "height": {
            "type": "integer"
          },
          "width": {
            "type": "integer"
          },
          "contentWidth": {
            "type": "integer"
          },
          "contentHeight": {
            "type": "integer"
          },
          "url": {
            "type": "string"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "images": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "url": {
            "type": "string"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "scale": {
            "type": "number",
            "default": 1,
            "minimum": 0.5,
            "maximum": 4
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "strokeIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "documents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "type": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "scale": {
            "type": "number",
            "default": 1,
            "minimum": 0.5,
            "maximum": 4
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "strokeIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "text": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer"
          },
          "height": {
            "type": "integer"
          },
          "text": {
            "type": "string",
            "minLength": 1,
            "maxLength": 3000
          },
          "fontFamily": {
            "type": "string",
            "enum": ["Dosis", "Helvetica", "Times New Roman", "Source Code Pro", "Aleo", "Exo 2"],
            "default": "Dosis"
          },
          "fontSize": {
            "type": "integer",
            "default": 64
          },
          "fontColor": {
            "type": "string",
            "default": "#ffffff"
          },
          "fontWeight": {
            "type": "string",
            "enum": ["normal", "bold"],
            "default": "normal"
          },
          "fontStyle": {
            "type": "string",
            "enum": ["normal", "italic"],
            "default": "normal"
          },
          "textTransform": {
            "type": "string",
            "enum": ["inherit", "uppercase"],
            "default": "inherit"
          },
          "backgroundColor": {
            "type": "string",
            "default": "#ea3e35"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "surface": {
            "type": "string",
            "default": null
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "strokes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "penColor": {
            "type": "string",
            "enum": ["White", "Gray", "Yellow", "Red", "Green", "Purple", "Cyan"],
            "default": "White"
          },
          "size": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100
          },
          "brushType": {
            "type": "string",
            "enum": ["Pen", "Eraser"],
            "default": "Pen"
          },
          "points": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "targetId": {
            "type": "string"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "videos": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "507f191e810c19729de860ea"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer"
          },
          "height": {
            "type": "integer"
          },
          "title": {
            "type": "string",
            "example": "Text"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          }
        }
      }
    },
    "grids": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "507f191e810c19729de860ea"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer"
          },
          "height": {
            "type": "integer"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "horizontalMargin": {
            "type": "integer"
          },
          "verticalMargin": {
            "type": "integer"
          },
          "cellWidth": {
            "type": "integer"
          },
          "cellHeight": {
            "type": "integer"
          },
          "rows": {
            "type": "integer"
          },
          "columns": {
            "type": "integer"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "elements": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "row": {
                  "type": "integer"
                },
                "column": {
                  "type": "integer"
                }
              }
            }
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Comments List

Get list of comments for the specified object.

Details

Path: /v1/workspaces/<workspace_id>/elements/<object_type>/<object_id>/comments
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
object_type string Required The type of object to get the comment details Allowed values:
 - "documents"
 - "notes"
 - "images"
 - "text"
 - "canvas"
 - "browsers"
object_id string Required The ID of the object to get the comment details

Response Schema

{
  "type": "object",
  "properties": {
    "comments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "text": {
            "type": "string"
          },
          "parentId": {
            "type": "string"
          },
          "actorType": {
            "type": "string"
          },
          "actorId": {
            "type": "string"
          },
          "date": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Comment Create

Add a comment on the specified object.

Details

Path: /v1/workspaces/<workspace_id>/elements/<object_type>/<object_id>/comments
HTTP Method: POST
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
object_type string Required The type of object to receive the comment Allowed values:
 - "documents"
 - "notes"
 - "images"
 - "text"
 - "canvas"
 - "browsers"
object_id string Required The ID of the object to receive the comment

Body

Name Type Required? Default Description
text string Required The body of the comment
parentId string Optional Optional ID of parent comment if this is to be a child response. Only one level of nesting is supported.

Response Schema

{
  "type": "object",
  "properties": {
    "comment": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "text": {
          "type": "string"
        },
        "parentId": {
          "type": "string"
        },
        "actorType": {
          "type": "string"
        },
        "actorId": {
          "type": "string"
        },
        "date": {
          "type": "string",
          "format": "date-time"
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Create Document in Canvas

Create a document in the Canvas.
The supported file extensions are: pdf, docx, pptx, xlsx, doc, ppt, xls, mov, mp4.
See examples of its use in the Guides section

Details

Path: /v1/workspaces/<workspace_id>/elements/canvas/<canvas_id>/documents
HTTP Method: POST
Accepted content types: multipart/form-data
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: multipart/form-data

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
canvas_id string Required The Unique ID of the canvas

Form Data

Name Type Required? Default Description
x integer Optional 0 Position - X
y integer Optional 0 Position - Y
title string Required Title of document
pin boolean Optional false It's Pinned or not
scale number Optional 1 Document Size
document string Required The Document to upload.

Response Schema

{
  "type": "object",
  "properties": {
    "document": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "type": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "pin": {
          "type": "boolean",
          "default": false
        },
        "scale": {
          "type": "number",
          "default": 1,
          "minimum": 0.5,
          "maximum": 4
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "strokeIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Documents List

Get list of documents in the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/documents
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace

Response Schema

{
  "type": "object",
  "properties": {
    "documents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "type": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "scale": {
            "type": "number",
            "default": 1,
            "minimum": 0.5,
            "maximum": 4
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "strokeIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Create Document in Workspace

Create a document in the workspace.
The supported file extensions are: pdf, docx, pptx, xlsx, doc, ppt, xls, mov, mp4.
See examples of its use in the Guides section

Details

Path: /v1/workspaces/<workspace_id>/elements/documents
HTTP Method: POST
Accepted content types: multipart/form-data
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: multipart/form-data

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace

Form Data

Name Type Required? Default Description
x integer Optional 0 Position - X
y integer Optional 0 Position - Y
title string Required Title of document
pin boolean Optional false It's Pinned or not
scale number Optional 1 Document Size
document string Required The Document to upload.

Response Schema

{
  "type": "object",
  "properties": {
    "document": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "type": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "pin": {
          "type": "boolean",
          "default": false
        },
        "scale": {
          "type": "number",
          "default": 1,
          "minimum": 0.5,
          "maximum": 4
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "strokeIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Get document details by Id

Get document details by Id.

Details

Path: /v1/workspaces/<workspace_id>/elements/documents/<document_id>
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
document_id string Required The Unique ID of the document

Response Schema

{
  "type": "object",
  "properties": {
    "document": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "type": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "pin": {
          "type": "boolean",
          "default": false
        },
        "scale": {
          "type": "number",
          "default": 1,
          "minimum": 0.5,
          "maximum": 4
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "strokeIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Document Update

Update the specified document in the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/documents/<document_id>
HTTP Method: PUT
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
document_id string Required The Unique ID of the document

Body

Name Type Required? Default Description
x integer Optional 0
y integer Optional 0
pin boolean Optional false
scale number Optional 1 Minimum: 0.5 Maximum: 4

Response Schema

{
  "type": "object",
  "properties": {
    "document": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "type": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "pin": {
          "type": "boolean",
          "default": false
        },
        "scale": {
          "type": "number",
          "default": 1,
          "minimum": 0.5,
          "maximum": 4
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "strokeIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Document Delete

Delete the specified document from the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/documents/<document_id>
HTTP Method: DELETE
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
document_id string Required The Unique ID of the document

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Element List

Get list of elements in the workspace

Details

Path: /v1/workspaces/<workspace_id>/elements
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace

Response Schema

{
  "type": "object",
  "properties": {
    "notes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "507f191e810c19729de860ea"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer",
            "example": 560
          },
          "height": {
            "type": "integer",
            "example": 320
          },
          "text": {
            "type": "string",
            "example": "Text"
          },
          "fontWeight": {
            "type": "string",
            "enum": ["normal", "bold"],
            "default": "normal"
          },
          "fontSize": {
            "type": "integer",
            "default": 64
          },
          "textTransform": {
            "type": "string",
            "enum": ["inherit", "uppercase"],
            "default": "inherit"
          },
          "backgroundColor": {
            "type": "string",
            "enum": ["Beige", "Blue", "Gold", "Grey", "Red", "Teal", "Yellow"],
            "default": "Teal"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "scale": {
            "type": "number",
            "default": 1,
            "minimum": 0.5,
            "maximum": 4
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "strokeIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "text": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer"
          },
          "height": {
            "type": "integer"
          },
          "text": {
            "type": "string",
            "minLength": 1,
            "maxLength": 3000
          },
          "fontFamily": {
            "type": "string",
            "enum": ["Dosis", "Helvetica", "Times New Roman", "Source Code Pro", "Aleo", "Exo 2"],
            "default": "Dosis"
          },
          "fontSize": {
            "type": "integer",
            "default": 64
          },
          "fontColor": {
            "type": "string",
            "default": "#ffffff"
          },
          "fontWeight": {
            "type": "string",
            "enum": ["normal", "bold"],
            "default": "normal"
          },
          "fontStyle": {
            "type": "string",
            "enum": ["normal", "italic"],
            "default": "normal"
          },
          "textTransform": {
            "type": "string",
            "enum": ["inherit", "uppercase"],
            "default": "inherit"
          },
          "backgroundColor": {
            "type": "string",
            "default": "#ea3e35"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "surface": {
            "type": "string",
            "default": null
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "documents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "type": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "scale": {
            "type": "number",
            "default": 1,
            "minimum": 0.5,
            "maximum": 4
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "strokeIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "canvas": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "507f191e810c19729de860ea"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer"
          },
          "height": {
            "type": "integer"
          },
          "name": {
            "type": "string",
            "example": "Text"
          },
          "borderColor": {
            "type": "string",
            "enum": ["Red", "Yellow", "Green", "Blue"],
            "default": "Red"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "children": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "images": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "url": {
            "type": "string"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "scale": {
            "type": "number",
            "default": 1,
            "minimum": 0.5,
            "maximum": 4
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "strokeIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "videos": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "507f191e810c19729de860ea"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer"
          },
          "height": {
            "type": "integer"
          },
          "title": {
            "type": "string",
            "example": "Text"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          }
        }
      }
    },
    "grids": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "507f191e810c19729de860ea"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer"
          },
          "height": {
            "type": "integer"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "horizontalMargin": {
            "type": "integer"
          },
          "verticalMargin": {
            "type": "integer"
          },
          "cellWidth": {
            "type": "integer"
          },
          "cellHeight": {
            "type": "integer"
          },
          "rows": {
            "type": "integer"
          },
          "columns": {
            "type": "integer"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "elements": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "row": {
                  "type": "integer"
                },
                "column": {
                  "type": "integer"
                }
              }
            }
          }
        }
      }
    },
    "browsers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "height": {
            "type": "integer"
          },
          "width": {
            "type": "integer"
          },
          "contentWidth": {
            "type": "integer"
          },
          "contentHeight": {
            "type": "integer"
          },
          "url": {
            "type": "string"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    },
    "strokes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "penColor": {
            "type": "string",
            "enum": ["White", "Gray", "Yellow", "Red", "Green", "Purple", "Cyan"],
            "default": "White"
          },
          "size": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100
          },
          "brushType": {
            "type": "string",
            "enum": ["Pen", "Eraser"],
            "default": "Pen"
          },
          "points": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "targetId": {
            "type": "string"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Grids List

Get list of grids in the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/grids
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace

Response Schema

{
  "type": "object",
  "properties": {
    "grids": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "507f191e810c19729de860ea"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer"
          },
          "height": {
            "type": "integer"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "horizontalMargin": {
            "type": "integer"
          },
          "verticalMargin": {
            "type": "integer"
          },
          "cellWidth": {
            "type": "integer"
          },
          "cellHeight": {
            "type": "integer"
          },
          "rows": {
            "type": "integer"
          },
          "columns": {
            "type": "integer"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "elements": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "row": {
                  "type": "integer"
                },
                "column": {
                  "type": "integer"
                }
              }
            }
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Get grid details by Id

Get grid details by Id.

Details

Path: /v1/workspaces/<workspace_id>/elements/grids/<grid_id>
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
grid_id string Required The Unique ID of the grid element

Response Schema

{
  "type": "object",
  "properties": {
    "grid": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "507f191e810c19729de860ea"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "width": {
          "type": "integer"
        },
        "height": {
          "type": "integer"
        },
        "pin": {
          "type": "boolean",
          "default": false
        },
        "horizontalMargin": {
          "type": "integer"
        },
        "verticalMargin": {
          "type": "integer"
        },
        "cellWidth": {
          "type": "integer"
        },
        "cellHeight": {
          "type": "integer"
        },
        "rows": {
          "type": "integer"
        },
        "columns": {
          "type": "integer"
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "elements": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "row": {
                "type": "integer"
              },
              "column": {
                "type": "integer"
              }
            }
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Create Image in Canvas

Create an image in the canvas. The image may be uploaded as a binary attachment, multipart form data, or via a remote url.
The supported file extensions are: jpg, png, jpeg, tiff.
See examples of its use in the Guides section.

Details

Path: /v1/workspaces/<workspace_id>/elements/canvas/<canvas_id>/images
HTTP Method: POST
Accepted content types: multipart/form-data
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: multipart/form-data

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
canvas_id string Required The Unique ID of the canvas

Form Data

Name Type Required? Default Description
x integer Optional 0 Position - X
y integer Optional 0 Position - Y
url string Optional
image string Required The Image to upload.
pin boolean Optional false It's Pinned or not
scale number Optional 1 Image Size

Response Schema

{
  "type": "object",
  "properties": {
    "image": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "url": {
          "type": "string"
        },
        "pin": {
          "type": "boolean",
          "default": false
        },
        "scale": {
          "type": "number",
          "default": 1,
          "minimum": 0.5,
          "maximum": 4
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "strokeIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Images List

Get list of images in the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/images
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace

Response Schema

{
  "type": "object",
  "properties": {
    "images": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "url": {
            "type": "string"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "scale": {
            "type": "number",
            "default": 1,
            "minimum": 0.5,
            "maximum": 4
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "strokeIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Create Image in Workspace

Create an image in the Workspace. The image may be uploaded as a binary attachment, multipart form data, or via a remote url.
The supported file extensions are: jpg, png, jpeg, tiff.
See examples of its use in the Guides section.

Details

Path: /v1/workspaces/<workspace_id>/elements/images
HTTP Method: POST
Accepted content types: multipart/form-data
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: multipart/form-data

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace

Form Data

Name Type Required? Default Description
x integer Optional 0 Position - X
y integer Optional 0 Position - Y
url string Optional
image string Required The Image to upload.
pin boolean Optional false It's Pinned or not
scale number Optional 1 Image Size

Response Schema

{
  "type": "object",
  "properties": {
    "image": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "url": {
          "type": "string"
        },
        "pin": {
          "type": "boolean",
          "default": false
        },
        "scale": {
          "type": "number",
          "default": 1,
          "minimum": 0.5,
          "maximum": 4
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "strokeIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Get image details by Id

Get image details by Id.

Details

Path: /v1/workspaces/<workspace_id>/elements/images/<image_id>
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
image_id string Required The Unique ID of the image

Response Schema

{
  "type": "object",
  "properties": {
    "image": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "url": {
          "type": "string"
        },
        "pin": {
          "type": "boolean",
          "default": false
        },
        "scale": {
          "type": "number",
          "default": 1,
          "minimum": 0.5,
          "maximum": 4
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "strokeIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Image Update

Update the specified image in the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/images/<image_id>
HTTP Method: PUT
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
image_id string Required The Unique ID of the image

Body

Name Type Required? Default Description
x integer Optional 0
y integer Optional 0
pin boolean Optional false
scale number Optional 1 Minimum: 0.5 Maximum: 4

Response Schema

{
  "type": "object",
  "properties": {
    "image": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "url": {
          "type": "string"
        },
        "pin": {
          "type": "boolean",
          "default": false
        },
        "scale": {
          "type": "number",
          "default": 1,
          "minimum": 0.5,
          "maximum": 4
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "strokeIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Image Delete

Delete the specified image from the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/images/<image_id>
HTTP Method: DELETE
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
image_id string Required The Unique ID of the image

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Get all listeners

Get all listeners for the user. You can filter listeners using workspace_id or organization_id

Details

Path: /v1/listeners
HTTP Method: GET
Authorization: Bearer Token
Parameters: header query

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Query

Name Type Required? Description
workspace_id string Optional workspace UID
organization_id string Optional organization ID

Response Schema

{
  "type": "object",
  "properties": {
    "listeners": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "507f191e810c19729de860ea"
        },
        "type": {
          "type": "string",
          "enum": ["organization", "workspace"]
        },
        "organizationId": {
          "type": "string"
        },
        "workspaceId": {
          "type": "string"
        },
        "targetId": {
          "type": "string"
        },
        "targetType": {
          "type": "string"
        },
        "eventTypes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "url": {
          "type": "string"
        },
        "status": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": ["ACTIVE", "IN_ACTIVE"]
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Listener Create

Add listener to a workspace.

Details

Path: /v1/listeners
HTTP Method: POST
Accepted content types: application/json
Authorization: Bearer Token
Parameters: header

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Body

Name Type Required? Default Description
type string Required Allowed values:
 - "organization"
 - "workspace"
url string Required
organizationId string Optional
workspaceId string Optional
targetId string Optional
eventTypes array Required

Response Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "507f191e810c19729de860ea"
    },
    "type": {
      "type": "string",
      "enum": ["organization", "workspace"]
    },
    "organizationId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    },
    "targetId": {
      "type": "string"
    },
    "targetType": {
      "type": "string"
    },
    "eventTypes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "url": {
      "type": "string"
    },
    "status": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": ["ACTIVE", "IN_ACTIVE"]
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Get a Listener

Get a listener by id.

Details

Path: /v1/listeners/<listener_id>
HTTP Method: GET
Authorization: Bearer Token
Parameters: header path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
listener_id string Required The ID of the listener

Response Schema

{
  "type": "object",
  "properties": {
    "listeners": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "507f191e810c19729de860ea"
        },
        "type": {
          "type": "string",
          "enum": ["organization", "workspace"]
        },
        "organizationId": {
          "type": "string"
        },
        "workspaceId": {
          "type": "string"
        },
        "targetId": {
          "type": "string"
        },
        "targetType": {
          "type": "string"
        },
        "eventTypes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "url": {
          "type": "string"
        },
        "status": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": ["ACTIVE", "IN_ACTIVE"]
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Update a listener in workspace

Update a listener in the specified workspace.

Details

Path: /v1/listeners/<listener_id>
HTTP Method: PUT
Accepted content types: application/json
Authorization: Bearer Token
Parameters: header path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
listener_id string Required The Unique ID of the listener

Body

Name Type Required? Default Description
url string Optional
targetId string Optional
eventTypes array Optional
status string Optional Allowed values:
 - "ACTIVE"
 - "IN_ACTIVE"

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "listener_id": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Listener Delete

Delete the specified listener from the workspace.

Details

Path: /v1/listeners/<listener_id>
HTTP Method: DELETE
Authorization: Bearer Token
Parameters: header path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
listener_id string Required The Unique ID of the listener

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Add Note to canvas

Add a note to the canvas.

Details

Path: /v1/workspaces/<workspace_id>/elements/canvas/<canvas_id>/notes
HTTP Method: POST
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
canvas_id string Required The Unique ID of the canvas

Body

Name Type Required? Default Description
x integer Optional 0
y integer Optional 0
text string Required
fontWeight string Optional normal Allowed values:
 - "normal"
 - "bold"
textTransform string Optional inherit Allowed values:
 - "inherit"
 - "uppercase"
backgroundColor string Optional Teal Allowed values:
 - "Beige"
 - "Blue"
 - "Gold"
 - "Grey"
 - "Red"
 - "Teal"
 - "Yellow"
pin boolean Optional false
scale number Optional 1 Minimum: 0.5 Maximum: 4
traits array Optional

Response Schema

{
  "type": "object",
  "properties": {
    "note": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "507f191e810c19729de860ea"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "width": {
          "type": "integer",
          "example": 560
        },
        "height": {
          "type": "integer",
          "example": 320
        },
        "text": {
          "type": "string",
          "example": "Text"
        },
        "fontWeight": {
          "type": "string",
          "enum": ["normal", "bold"],
          "default": "normal"
        },
        "fontSize": {
          "type": "integer",
          "default": 64
        },
        "textTransform": {
          "type": "string",
          "enum": ["inherit", "uppercase"],
          "default": "inherit"
        },
        "backgroundColor": {
          "type": "string",
          "enum": ["Beige", "Blue", "Gold", "Grey", "Red", "Teal", "Yellow"],
          "default": "Teal"
        },
        "pin": {
          "type": "boolean",
          "default": false
        },
        "scale": {
          "type": "number",
          "default": 1,
          "minimum": 0.5,
          "maximum": 4
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "strokeIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Notes List

Get list of notes in the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/notes
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace

Response Schema

{
  "type": "object",
  "properties": {
    "notes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "507f191e810c19729de860ea"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer",
            "example": 560
          },
          "height": {
            "type": "integer",
            "example": 320
          },
          "text": {
            "type": "string",
            "example": "Text"
          },
          "fontWeight": {
            "type": "string",
            "enum": ["normal", "bold"],
            "default": "normal"
          },
          "fontSize": {
            "type": "integer",
            "default": 64
          },
          "textTransform": {
            "type": "string",
            "enum": ["inherit", "uppercase"],
            "default": "inherit"
          },
          "backgroundColor": {
            "type": "string",
            "enum": ["Beige", "Blue", "Gold", "Grey", "Red", "Teal", "Yellow"],
            "default": "Teal"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "scale": {
            "type": "number",
            "default": 1,
            "minimum": 0.5,
            "maximum": 4
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "strokeIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Note Create

Create a note in the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/notes
HTTP Method: POST
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace

Body

Name Type Required? Default Description
x integer Optional 0
y integer Optional 0
text string Required
fontWeight string Optional normal Allowed values:
 - "normal"
 - "bold"
textTransform string Optional inherit Allowed values:
 - "inherit"
 - "uppercase"
backgroundColor string Optional Teal Allowed values:
 - "Beige"
 - "Blue"
 - "Gold"
 - "Grey"
 - "Red"
 - "Teal"
 - "Yellow"
pin boolean Optional false
scale number Optional 1 Minimum: 0.5 Maximum: 4
traits array Optional

Response Schema

{
  "type": "object",
  "properties": {
    "note": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "507f191e810c19729de860ea"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "width": {
          "type": "integer",
          "example": 560
        },
        "height": {
          "type": "integer",
          "example": 320
        },
        "text": {
          "type": "string",
          "example": "Text"
        },
        "fontWeight": {
          "type": "string",
          "enum": ["normal", "bold"],
          "default": "normal"
        },
        "fontSize": {
          "type": "integer",
          "default": 64
        },
        "textTransform": {
          "type": "string",
          "enum": ["inherit", "uppercase"],
          "default": "inherit"
        },
        "backgroundColor": {
          "type": "string",
          "enum": ["Beige", "Blue", "Gold", "Grey", "Red", "Teal", "Yellow"],
          "default": "Teal"
        },
        "pin": {
          "type": "boolean",
          "default": false
        },
        "scale": {
          "type": "number",
          "default": 1,
          "minimum": 0.5,
          "maximum": 4
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "strokeIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Get note details by Id

Get note details by Id.

Details

Path: /v1/workspaces/<workspace_id>/elements/notes/<note_id>
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
note_id string Required The Unique ID of the notecard

Response Schema

{
  "type": "object",
  "properties": {
    "note": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "507f191e810c19729de860ea"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "width": {
          "type": "integer",
          "example": 560
        },
        "height": {
          "type": "integer",
          "example": 320
        },
        "text": {
          "type": "string",
          "example": "Text"
        },
        "fontWeight": {
          "type": "string",
          "enum": ["normal", "bold"],
          "default": "normal"
        },
        "fontSize": {
          "type": "integer",
          "default": 64
        },
        "textTransform": {
          "type": "string",
          "enum": ["inherit", "uppercase"],
          "default": "inherit"
        },
        "backgroundColor": {
          "type": "string",
          "enum": ["Beige", "Blue", "Gold", "Grey", "Red", "Teal", "Yellow"],
          "default": "Teal"
        },
        "pin": {
          "type": "boolean",
          "default": false
        },
        "scale": {
          "type": "number",
          "default": 1,
          "minimum": 0.5,
          "maximum": 4
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "strokeIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Note Update

Update the specified note in the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/notes/<note_id>
HTTP Method: PUT
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
note_id string Required The Unique ID of the notecard

Body

Name Type Required? Default Description
x integer Optional 0
y integer Optional 0
text string Optional
fontWeight string Optional normal Allowed values:
 - "normal"
 - "bold"
textTransform string Optional inherit Allowed values:
 - "inherit"
 - "uppercase"
backgroundColor string Optional Teal Allowed values:
 - "Beige"
 - "Blue"
 - "Gold"
 - "Grey"
 - "Red"
 - "Teal"
 - "Yellow"
pin boolean Optional false
scale number Optional 1 Minimum: 0.5 Maximum: 4

Response Schema

{
  "type": "object",
  "properties": {
    "note": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "507f191e810c19729de860ea"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "width": {
          "type": "integer",
          "example": 560
        },
        "height": {
          "type": "integer",
          "example": 320
        },
        "text": {
          "type": "string",
          "example": "Text"
        },
        "fontWeight": {
          "type": "string",
          "enum": ["normal", "bold"],
          "default": "normal"
        },
        "fontSize": {
          "type": "integer",
          "default": 64
        },
        "textTransform": {
          "type": "string",
          "enum": ["inherit", "uppercase"],
          "default": "inherit"
        },
        "backgroundColor": {
          "type": "string",
          "enum": ["Beige", "Blue", "Gold", "Grey", "Red", "Teal", "Yellow"],
          "default": "Teal"
        },
        "pin": {
          "type": "boolean",
          "default": false
        },
        "scale": {
          "type": "number",
          "default": 1,
          "minimum": 0.5,
          "maximum": 4
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "strokeIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Note Delete

Delete the specified note from the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/notes/<note_id>
HTTP Method: DELETE
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
note_id string Required The Unique ID of the note

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Get an Organization

Get an organization by organization id. If the user is NOT in the organization, require Manage Application Organizations permission group.

Details

Path: /v1/organizations/<organization_id>
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
organization_id integer Required Organization id

Response Schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "locked_at": {
          "type": "string",
          "format": "date-time"
        },
        "account_id": {
          "type": "integer"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time"
        },
        "expiration": {
          "type": "string",
          "format": "date-time"
        },
        "plan": {
          "type": "object",
          "properties": {
            "id": {
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "owner": {
          "type": "object",
          "properties": {
            "id": {
              "type": "integer"
            },
            "email": {
              "type": "string"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "locked_at": {
              "type": "string",
              "format": "date-time"
            },
            "created_at": {
              "type": "string",
              "format": "date-time"
            },
            "updated_at": {
              "type": "string",
              "format": "date-time"
            }
          }
        },
        "metadata": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            },
            "required": ["key", "value"]
          }
        },
        "is_guest_invite_requires_approval": {
          "type": "boolean",
          "default": false
        },
        "default_public_workspace_role_id": {
          "type": "integer"
        },
        "default_organization_user_role_id": {
          "type": "integer"
        },
        "is_custom_role_enabled": {
          "type": "boolean",
          "default": false
        },
        "saml_provider": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "metadata_url": {
              "type": "string"
            },
            "admin_email": {
              "type": "string"
            },
            "type": {
              "type": "string",
              "enum": ["okta", "onelogin", "pingfederate", "adfs", "f5"]
            }
          }
        },
        "is_cam_enabled": {
          "type": "boolean",
          "default": false
        },
        "denyOnNoCamData": {
          "type": "boolean",
          "default": true
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
404 Resource Not Found
500 Internal Server Error

Get Organization Roles of an Organization

Get organization roles within an organization. Require List Roles permission group.

Details

Path: /v1/organizations/<organization_id>/organization_roles
HTTP Method: GET
Authorization: Bearer Token
Parameters: path query

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
organization_id integer Required Organization id

Query

Name Type Required? Description
query string Optional Search query
order_by string Optional Order by fields
order_direction string Optional ASC or DESC Allowed values:
 - "ASC"
 - "DESC"
limit integer Optional limit
offset integer Optional offset

Response Schema

{
  "type": "object",
  "properties": {
    "organization_roles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "is_default": {
            "type": "boolean"
          },
          "display_order": {
            "type": "integer"
          },
          "organization_id": {
            "type": "integer"
          },
          "is_custom": {
            "type": "boolean"
          },
          "can_add_user": {
            "type": "boolean"
          },
          "can_remove_user": {
            "type": "boolean"
          },
          "can_edit_user_info": {
            "type": "boolean"
          },
          "can_list_organization_users": {
            "type": "boolean"
          },
          "can_add_admin": {
            "type": "boolean"
          },
          "can_remove_admin": {
            "type": "boolean"
          },
          "can_edit_admin_info": {
            "type": "boolean"
          },
          "can_add_guest": {
            "type": "boolean"
          },
          "can_remove_guest": {
            "type": "boolean"
          },
          "can_edit_guest_info": {
            "type": "boolean"
          },
          "can_create_workspace": {
            "type": "boolean"
          },
          "can_view_public_workspace": {
            "type": "boolean"
          },
          "can_approve_guest_invite": {
            "type": "boolean"
          },
          "can_change_organization_settings": {
            "type": "boolean"
          },
          "can_add_organization_role": {
            "type": "boolean"
          },
          "can_edit_organization_role": {
            "type": "boolean"
          },
          "can_delete_organization_role": {
            "type": "boolean"
          },
          "can_add_workspace_role": {
            "type": "boolean"
          },
          "can_edit_workspace_role": {
            "type": "boolean"
          },
          "can_delete_workspace_role": {
            "type": "boolean"
          },
          "can_change_admin_role": {
            "type": "boolean"
          },
          "can_change_user_role": {
            "type": "boolean"
          },
          "can_change_guest_role": {
            "type": "boolean"
          },
          "can_upgrade_guest_to_user": {
            "type": "boolean"
          },
          "can_downgrade_user_to_guest": {
            "type": "boolean"
          },
          "can_upgrade_user_to_admin": {
            "type": "boolean"
          },
          "can_downgrade_admin_to_user": {
            "type": "boolean"
          },
          "can_list_organization_roles": {
            "type": "boolean"
          },
          "can_list_workspace_roles": {
            "type": "boolean"
          },
          "can_upgrade_guest_to_admin": {
            "type": "boolean"
          },
          "can_downgrade_admin_to_guest": {
            "type": "boolean"
          }
        },
        "required": ["id", "name"]
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "size": {
      "type": "integer"
    },
    "paging": {
      "type": "object",
      "properties": {
        "prev": {
          "type": "string"
        },
        "self": {
          "type": "string"
        },
        "next": {
          "type": "string"
        }
      }
    }
  },
  "required": ["organization_roles", "total", "limit", "offset", "size", "paging"]
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
500 Internal Server Error

Get all Users in an Organization

Get all the users in an organization. Require Manage Application Users and Manage Application Organizations permission groups OR only View Organization User List permission group.

Details

Path: /v1/organizations/<organization_id>/users
HTTP Method: GET
Authorization: Bearer Token
Parameters: path query

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
organization_id integer Required Organization id

Query

Name Type Required? Description
query string Optional Search query
order_by string Optional Order by fields
order_direction string Optional ASC or DESC Allowed values:
 - "ASC"
 - "DESC"
limit integer Optional limit
offset integer Optional offset
filter_by string Optional Filter by field
role string Optional Search user by role id

Response Schema

{
  "type": "object",
  "properties": {
    "organization_users": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "email": {
            "type": "string"
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "industry": {
            "type": "string"
          },
          "phone_number": {
            "type": "string"
          },
          "locked_at": {
            "type": "string",
            "format": "date-time"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          },
          "avatar_url": {
            "type": "string"
          },
          "invited_state": {
            "type": "string",
            "enum": ["PENDING_INVITE", "INVITED_USER", "INVITED_GUEST", "ACCEPTED"]
          },
          "organization_role": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "is_default": {
                "type": "boolean"
              },
              "display_order": {
                "type": "integer"
              },
              "organization_id": {
                "type": "integer"
              },
              "is_custom": {
                "type": "boolean"
              },
              "can_add_user": {
                "type": "boolean"
              },
              "can_remove_user": {
                "type": "boolean"
              },
              "can_edit_user_info": {
                "type": "boolean"
              },
              "can_list_organization_users": {
                "type": "boolean"
              },
              "can_add_admin": {
                "type": "boolean"
              },
              "can_remove_admin": {
                "type": "boolean"
              },
              "can_edit_admin_info": {
                "type": "boolean"
              },
              "can_add_guest": {
                "type": "boolean"
              },
              "can_remove_guest": {
                "type": "boolean"
              },
              "can_edit_guest_info": {
                "type": "boolean"
              },
              "can_create_workspace": {
                "type": "boolean"
              },
              "can_view_public_workspace": {
                "type": "boolean"
              },
              "can_approve_guest_invite": {
                "type": "boolean"
              },
              "can_change_organization_settings": {
                "type": "boolean"
              },
              "can_add_organization_role": {
                "type": "boolean"
              },
              "can_edit_organization_role": {
                "type": "boolean"
              },
              "can_delete_organization_role": {
                "type": "boolean"
              },
              "can_add_workspace_role": {
                "type": "boolean"
              },
              "can_edit_workspace_role": {
                "type": "boolean"
              },
              "can_delete_workspace_role": {
                "type": "boolean"
              },
              "can_change_admin_role": {
                "type": "boolean"
              },
              "can_change_user_role": {
                "type": "boolean"
              },
              "can_change_guest_role": {
                "type": "boolean"
              },
              "can_upgrade_guest_to_user": {
                "type": "boolean"
              },
              "can_downgrade_user_to_guest": {
                "type": "boolean"
              },
              "can_upgrade_user_to_admin": {
                "type": "boolean"
              },
              "can_downgrade_admin_to_user": {
                "type": "boolean"
              },
              "can_list_organization_roles": {
                "type": "boolean"
              },
              "can_list_workspace_roles": {
                "type": "boolean"
              },
              "can_upgrade_guest_to_admin": {
                "type": "boolean"
              },
              "can_downgrade_admin_to_guest": {
                "type": "boolean"
              }
            },
            "required": ["id", "name"]
          }
        }
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "size": {
      "type": "integer"
    },
    "paging": {
      "type": "object",
      "properties": {
        "prev": {
          "type": "string"
        },
        "self": {
          "type": "string"
        },
        "next": {
          "type": "string"
        }
      }
    }
  },
  "required": ["organization_users", "total", "limit", "offset", "size", "paging"]
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
500 Internal Server Error

Add a User to an Organization

Add a user to an organization. Require Manage Organization users permission group.

Details

Path: /v1/organizations/<organization_id>/users
HTTP Method: POST
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
organization_id integer Required Organization id

Body

Name Type Required? Default Description
email string Required
organization_role_id integer Optional

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
500 Internal Server Error

Update a User in an Organization

Update user in an organization. Based on the target user's type, require Manage Organization Users, or , or permission group.

Details

Path: /v1/organizations/<organization_id>/users/<user_id>
HTTP Method: PUT
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
organization_id integer Required Organization id
user_id integer Required User id

Body

Name Type Required? Default Description
organization_role_id integer Required

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
500 Internal Server Error

Remove a User from an Organization

Remove a user from an organization. Based on the target user type, require Manage Organization Users, or *Manage Guests, or Manage Admins permission group.

Details

Path: /v1/organizations/<organization_id>/users/<user_id>
HTTP Method: DELETE
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
organization_id integer Required Organization id
user_id integer Required User id

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
500 Internal Server Error

Get Workspace Roles in an Organization

Get workspace roles within an organization. Require List Roles permission group.

Details

Path: /v1/organizations/<organization_id>/workspace_roles
HTTP Method: GET
Authorization: Bearer Token
Parameters: path query

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
organization_id integer Required Organization id

Query

Name Type Required? Description
query string Optional Search query
order_by string Optional Order by fields
order_direction string Optional ASC or DESC Allowed values:
 - "ASC"
 - "DESC"
limit integer Optional limit
offset integer Optional offset

Response Schema

{
  "type": "object",
  "properties": {
    "workspace_roles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "is_default": {
            "type": "boolean"
          },
          "display_order": {
            "type": "integer"
          },
          "organization_id": {
            "type": "integer"
          },
          "is_custom": {
            "type": "boolean"
          },
          "is_saml": {
            "type": "boolean"
          },
          "can_edit_workspace_settings": {
            "type": "boolean"
          },
          "can_edit_workspace_content": {
            "type": "boolean"
          },
          "can_duplicate_workspace": {
            "type": "boolean"
          },
          "can_delete_workspace": {
            "type": "boolean"
          },
          "can_add_user": {
            "type": "boolean"
          },
          "can_remove_user": {
            "type": "boolean"
          },
          "can_add_guest": {
            "type": "boolean"
          },
          "can_remove_guest": {
            "type": "boolean"
          },
          "can_send_to_wall": {
            "type": "boolean"
          },
          "can_change_publish_state": {
            "type": "boolean"
          },
          "can_change_public_state": {
            "type": "boolean"
          },
          "can_download_assets": {
            "type": "boolean"
          },
          "can_change_user_role": {
            "type": "boolean"
          },
          "can_change_owner": {
            "type": "boolean"
          },
          "can_change_organization": {
            "type": "boolean"
          },
          "can_list_collaborators": {
            "type": "boolean"
          },
          "can_send_message": {
            "type": "boolean"
          },
          "can_view_workspace_settings": {
            "type": "boolean"
          },
          "can_comment": {
            "type": "boolean"
          },
          "can_at_mention": {
            "type": "boolean"
          },
          "can_view_workspace_content": {
            "type": "boolean"
          },
          "can_export_workspace": {
            "type": "boolean"
          },
          "can_import_workspace": {
            "type": "boolean"
          }
        },
        "required": ["id", "name"]
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "size": {
      "type": "integer"
    },
    "paging": {
      "type": "object",
      "properties": {
        "prev": {
          "type": "string"
        },
        "self": {
          "type": "string"
        },
        "next": {
          "type": "string"
        }
      }
    }
  },
  "required": ["workspace_roles", "total", "limit", "offset", "size", "paging"]
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
500 Internal Server Error

Get all Roles

Get all the roles in the application. Based on the desired result, require List Application Roles or List Roles permission group.

Details

Path: /v1/roles
HTTP Method: GET
Authorization: Bearer Token
Parameters: query

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Query

Name Type Required? Description
resource_type string Optional resource_type => application, organization, workspace
type string Optional type => owner, admin, user, guest
organization_id integer Optional Organization id
is_custom boolean Optional is_custom
query string Optional Search query
order_by string Optional Order by fields
order_direction string Optional ASC or DESC Allowed values:
 - "ASC"
 - "DESC"
limit integer Optional limit
offset integer Optional offset

Response Schema

{
  "type": "object",
  "properties": {
    "roles": {
      "type": "array",
      "items": {
        "allOf": [{
          "type": "object",
          "properties": {
            "id": {
              "type": "integer"
            },
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "resource_type": {
              "type": "string"
            },
            "type": {
              "type": "string"
            },
            "display_order": {
              "type": "integer"
            },
            "organization_id": {
              "type": "integer"
            },
            "is_custom": {
              "type": "boolean"
            }
          },
          "required": ["id", "name"]
        }, {
          "type": "object",
          "properties": {
            "built_permissions": {
              "type": "string"
            },
            "permission_groups": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer"
                  },
                  "name": {
                    "type": "string"
                  }
                }
              }
            },
            "permission_keys": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }]
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "size": {
      "type": "integer"
    },
    "paging": {
      "type": "object",
      "properties": {
        "prev": {
          "type": "string"
        },
        "self": {
          "type": "string"
        },
        "next": {
          "type": "string"
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
500 Internal Server Error

Get Session User

Get the current session user

Details

Path: /v1/session/user
HTTP Method: GET
Authorization: Bearer Token
Parameters:

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Response Schema

{
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "email": {
          "type": "string"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "industry": {
          "type": "string"
        },
        "phone_number": {
          "type": "string"
        },
        "locked_at": {
          "type": "string",
          "format": "date-time"
        },
        "archived": {
          "type": "boolean"
        },
        "avatar_url": {
          "type": "string"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time"
        },
        "application_role": {
          "type": "object",
          "properties": {
            "id": {
              "type": "integer"
            },
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "type": {
              "type": "string"
            },
            "is_default": {
              "type": "boolean"
            },
            "display_order": {
              "type": "integer"
            },
            "can_list_users": {
              "type": "boolean"
            },
            "can_list_organizations": {
              "type": "boolean"
            },
            "can_create_organizations": {
              "type": "boolean"
            },
            "can_edit_organizations": {
              "type": "boolean"
            },
            "can_delete_organizations": {
              "type": "boolean"
            },
            "can_edit_users": {
              "type": "boolean"
            },
            "can_list_walls": {
              "type": "boolean"
            },
            "can_create_walls": {
              "type": "boolean"
            },
            "can_edit_walls": {
              "type": "boolean"
            },
            "can_delete_walls": {
              "type": "boolean"
            },
            "can_list_plans": {
              "type": "boolean"
            },
            "can_create_plans": {
              "type": "boolean"
            },
            "can_edit_plans": {
              "type": "boolean"
            },
            "can_delete_plans": {
              "type": "boolean"
            },
            "can_lock_users": {
              "type": "boolean"
            },
            "can_lock_organizations": {
              "type": "boolean"
            },
            "can_delete_users": {
              "type": "boolean"
            },
            "can_create_help_menu": {
              "type": "boolean"
            },
            "can_edit_help_menu": {
              "type": "boolean"
            },
            "can_delete_help_menu": {
              "type": "boolean"
            },
            "can_list_saml_providers": {
              "type": "boolean"
            },
            "can_create_saml_providers": {
              "type": "boolean"
            },
            "can_edit_saml_providers": {
              "type": "boolean"
            },
            "can_delete_saml_providers": {
              "type": "boolean"
            },
            "can_create_broadcast_messages": {
              "type": "boolean"
            },
            "can_edit_broadcast_messages": {
              "type": "boolean"
            },
            "can_delete_broadcast_messages": {
              "type": "boolean"
            },
            "can_create_permission_groups": {
              "type": "boolean"
            },
            "can_delete_permission_groups": {
              "type": "boolean"
            },
            "can_edit_permission_groups": {
              "type": "boolean"
            },
            "can_list_application_roles": {
              "type": "boolean"
            },
            "can_trigger_webhook": {
              "type": "boolean"
            }
          },
          "required": ["id", "name"]
        },
        "user_preference": {
          "type": "object",
          "properties": {
            "notify_on_new_message": {
              "type": "boolean"
            }
          }
        }
      },
      "required": ["id", "email"]
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
500 Internal Server Error

Draw Stroke (Object)

Draw a stroke on an object. The points property is defined as a series of X,Y coordinates. For example, [0,0, 100,100] will draw a stroke from point 0,0 to point 100,100.

Details

Path: /v1/workspaces/<workspace_id>/elements/<object_type>/<object_id>/strokes
HTTP Method: POST
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
object_type string Required The object type to receive strokes Allowed values:
 - "notes"
 - "images"
 - "canvas"
object_id string Required The unique ID of the object to receive strokes

Body

Name Type Required? Default Description
penColor string Optional White Allowed values:
 - "White"
 - "Gray"
 - "Yellow"
 - "Red"
 - "Green"
 - "Purple"
 - "Cyan"
brushSize integer Optional Minimum: 1 Maximum: 100
brushType string Optional Pen Allowed values:
 - "Pen"
 - "Eraser"
points array Required
traits array Optional

Response Schema

{
  "type": "object",
  "properties": {
    "stroke": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "penColor": {
          "type": "string",
          "enum": ["White", "Gray", "Yellow", "Red", "Green", "Purple", "Cyan"],
          "default": "White"
        },
        "size": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100
        },
        "brushType": {
          "type": "string",
          "enum": ["Pen", "Eraser"],
          "default": "Pen"
        },
        "points": {
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "targetId": {
          "type": "string"
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Strokes List

Get list of strokes in the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/strokes
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace

Response Schema

{
  "type": "object",
  "properties": {
    "strokes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "penColor": {
            "type": "string",
            "enum": ["White", "Gray", "Yellow", "Red", "Green", "Purple", "Cyan"],
            "default": "White"
          },
          "size": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100
          },
          "brushType": {
            "type": "string",
            "enum": ["Pen", "Eraser"],
            "default": "Pen"
          },
          "points": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "targetId": {
            "type": "string"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Draw Stroke (Workspace)

Draw a stroke on the workspace directly. The points property is defined as a series of X,Y coordinates. For example, [0,0, 100,100] will draw a stroke from point 0,0 to point 100,100.

Details

Path: /v1/workspaces/<workspace_id>/elements/strokes
HTTP Method: POST
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace

Body

Name Type Required? Default Description
penColor string Optional White Allowed values:
 - "White"
 - "Gray"
 - "Yellow"
 - "Red"
 - "Green"
 - "Purple"
 - "Cyan"
brushSize integer Optional Minimum: 1 Maximum: 100
brushType string Optional Pen Allowed values:
 - "Pen"
 - "Eraser"
points array Required
traits array Optional

Response Schema

{
  "type": "object",
  "properties": {
    "stroke": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "penColor": {
          "type": "string",
          "enum": ["White", "Gray", "Yellow", "Red", "Green", "Purple", "Cyan"],
          "default": "White"
        },
        "size": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100
        },
        "brushType": {
          "type": "string",
          "enum": ["Pen", "Eraser"],
          "default": "Pen"
        },
        "points": {
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "targetId": {
          "type": "string"
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Get stroke details by Id

Get stroke details by Id.

Details

Path: /v1/workspaces/<workspace_id>/elements/strokes/<stroke_id>
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
stroke_id string Required The Unique ID of the stroke

Response Schema

{
  "type": "object",
  "properties": {
    "stroke": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "penColor": {
          "type": "string",
          "enum": ["White", "Gray", "Yellow", "Red", "Green", "Purple", "Cyan"],
          "default": "White"
        },
        "size": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100
        },
        "brushType": {
          "type": "string",
          "enum": ["Pen", "Eraser"],
          "default": "Pen"
        },
        "points": {
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "targetId": {
          "type": "string"
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Stroke Delete

Delete the specified stroke from the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/strokes/<stroke_id>
HTTP Method: DELETE
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
stroke_id string Required The Unique ID of the stroke

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Add Text to canvas

Add a text to the canvas.

Details

Path: /v1/workspaces/<workspace_id>/elements/canvas/<canvas_id>/text
HTTP Method: POST
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
canvas_id string Required The Unique ID of the canvas

Body

Name Type Required? Default Description
x integer Optional 0
y integer Optional 0
width integer Optional
height integer Optional
text string Required
fontFamily string Optional Dosis Allowed values:
 - "Dosis"
 - "Helvetica"
 - "Times New Roman"
 - "Source Code Pro"
 - "Aleo"
 - "Exo 2"
fontSize integer Optional 64
fontColor string Optional #ffffff
fontWeight string Optional normal Allowed values:
 - "normal"
 - "bold"
fontStyle string Optional normal Allowed values:
 - "normal"
 - "italic"
textTransform string Optional inherit Allowed values:
 - "inherit"
 - "uppercase"
backgroundColor string Optional #ea3e35
pin boolean Optional false
traits array Optional

Response Schema

{
  "type": "object",
  "properties": {
    "text": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "width": {
          "type": "integer"
        },
        "height": {
          "type": "integer"
        },
        "text": {
          "type": "string",
          "minLength": 1,
          "maxLength": 3000
        },
        "fontFamily": {
          "type": "string",
          "enum": ["Dosis", "Helvetica", "Times New Roman", "Source Code Pro", "Aleo", "Exo 2"],
          "default": "Dosis"
        },
        "fontSize": {
          "type": "integer",
          "default": 64
        },
        "fontColor": {
          "type": "string",
          "default": "#ffffff"
        },
        "fontWeight": {
          "type": "string",
          "enum": ["normal", "bold"],
          "default": "normal"
        },
        "fontStyle": {
          "type": "string",
          "enum": ["normal", "italic"],
          "default": "normal"
        },
        "textTransform": {
          "type": "string",
          "enum": ["inherit", "uppercase"],
          "default": "inherit"
        },
        "backgroundColor": {
          "type": "string",
          "default": "#ea3e35"
        },
        "pin": {
          "type": "boolean",
          "default": false
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "surface": {
          "type": "string",
          "default": null
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Text List

Get list of text in the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/text
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace

Response Schema

{
  "type": "object",
  "properties": {
    "text": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer"
          },
          "height": {
            "type": "integer"
          },
          "text": {
            "type": "string",
            "minLength": 1,
            "maxLength": 3000
          },
          "fontFamily": {
            "type": "string",
            "enum": ["Dosis", "Helvetica", "Times New Roman", "Source Code Pro", "Aleo", "Exo 2"],
            "default": "Dosis"
          },
          "fontSize": {
            "type": "integer",
            "default": 64
          },
          "fontColor": {
            "type": "string",
            "default": "#ffffff"
          },
          "fontWeight": {
            "type": "string",
            "enum": ["normal", "bold"],
            "default": "normal"
          },
          "fontStyle": {
            "type": "string",
            "enum": ["normal", "italic"],
            "default": "normal"
          },
          "textTransform": {
            "type": "string",
            "enum": ["inherit", "uppercase"],
            "default": "inherit"
          },
          "backgroundColor": {
            "type": "string",
            "default": "#ea3e35"
          },
          "pin": {
            "type": "boolean",
            "default": false
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "surface": {
            "type": "string",
            "default": null
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "traits": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
              "additionalProperties": true
            },
            "example": [{
              "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
            }]
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Text Create

Create a text element in the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/text
HTTP Method: POST
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace

Body

Name Type Required? Default Description
x integer Optional 0
y integer Optional 0
width integer Optional
height integer Optional
text string Required
fontFamily string Optional Dosis Allowed values:
 - "Dosis"
 - "Helvetica"
 - "Times New Roman"
 - "Source Code Pro"
 - "Aleo"
 - "Exo 2"
fontSize integer Optional 64
fontColor string Optional #ffffff
fontWeight string Optional normal Allowed values:
 - "normal"
 - "bold"
fontStyle string Optional normal Allowed values:
 - "normal"
 - "italic"
textTransform string Optional inherit Allowed values:
 - "inherit"
 - "uppercase"
backgroundColor string Optional #ea3e35
pin boolean Optional false
traits array Optional

Response Schema

{
  "type": "object",
  "properties": {
    "text": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "width": {
          "type": "integer"
        },
        "height": {
          "type": "integer"
        },
        "text": {
          "type": "string",
          "minLength": 1,
          "maxLength": 3000
        },
        "fontFamily": {
          "type": "string",
          "enum": ["Dosis", "Helvetica", "Times New Roman", "Source Code Pro", "Aleo", "Exo 2"],
          "default": "Dosis"
        },
        "fontSize": {
          "type": "integer",
          "default": 64
        },
        "fontColor": {
          "type": "string",
          "default": "#ffffff"
        },
        "fontWeight": {
          "type": "string",
          "enum": ["normal", "bold"],
          "default": "normal"
        },
        "fontStyle": {
          "type": "string",
          "enum": ["normal", "italic"],
          "default": "normal"
        },
        "textTransform": {
          "type": "string",
          "enum": ["inherit", "uppercase"],
          "default": "inherit"
        },
        "backgroundColor": {
          "type": "string",
          "default": "#ea3e35"
        },
        "pin": {
          "type": "boolean",
          "default": false
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "surface": {
          "type": "string",
          "default": null
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Get text details by Id

Get text details by Id.

Details

Path: /v1/workspaces/<workspace_id>/elements/text/<text_id>
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
text_id string Required The Unique ID of the text element

Response Schema

{
  "type": "object",
  "properties": {
    "text": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "width": {
          "type": "integer"
        },
        "height": {
          "type": "integer"
        },
        "text": {
          "type": "string",
          "minLength": 1,
          "maxLength": 3000
        },
        "fontFamily": {
          "type": "string",
          "enum": ["Dosis", "Helvetica", "Times New Roman", "Source Code Pro", "Aleo", "Exo 2"],
          "default": "Dosis"
        },
        "fontSize": {
          "type": "integer",
          "default": 64
        },
        "fontColor": {
          "type": "string",
          "default": "#ffffff"
        },
        "fontWeight": {
          "type": "string",
          "enum": ["normal", "bold"],
          "default": "normal"
        },
        "fontStyle": {
          "type": "string",
          "enum": ["normal", "italic"],
          "default": "normal"
        },
        "textTransform": {
          "type": "string",
          "enum": ["inherit", "uppercase"],
          "default": "inherit"
        },
        "backgroundColor": {
          "type": "string",
          "default": "#ea3e35"
        },
        "pin": {
          "type": "boolean",
          "default": false
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "surface": {
          "type": "string",
          "default": null
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Text Update

Update the specified text element.

Details

Path: /v1/workspaces/<workspace_id>/elements/text/<text_id>
HTTP Method: PUT
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
text_id string Required The Unique ID of the text element

Body

Name Type Required? Default Description
x integer Optional 0
y integer Optional 0
width integer Optional
height integer Optional
text string Optional
fontFamily string Optional Dosis Allowed values:
 - "Dosis"
 - "Helvetica"
 - "Times New Roman"
 - "Source Code Pro"
 - "Aleo"
 - "Exo 2"
fontSize integer Optional 64
fontColor string Optional #ffffff
fontWeight string Optional normal Allowed values:
 - "normal"
 - "bold"
fontStyle string Optional normal Allowed values:
 - "normal"
 - "italic"
textTransform string Optional inherit Allowed values:
 - "inherit"
 - "uppercase"
backgroundColor string Optional #ea3e35
pin boolean Optional false

Response Schema

{
  "type": "object",
  "properties": {
    "text": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "width": {
          "type": "integer"
        },
        "height": {
          "type": "integer"
        },
        "text": {
          "type": "string",
          "minLength": 1,
          "maxLength": 3000
        },
        "fontFamily": {
          "type": "string",
          "enum": ["Dosis", "Helvetica", "Times New Roman", "Source Code Pro", "Aleo", "Exo 2"],
          "default": "Dosis"
        },
        "fontSize": {
          "type": "integer",
          "default": 64
        },
        "fontColor": {
          "type": "string",
          "default": "#ffffff"
        },
        "fontWeight": {
          "type": "string",
          "enum": ["normal", "bold"],
          "default": "normal"
        },
        "fontStyle": {
          "type": "string",
          "enum": ["normal", "italic"],
          "default": "normal"
        },
        "textTransform": {
          "type": "string",
          "enum": ["inherit", "uppercase"],
          "default": "inherit"
        },
        "backgroundColor": {
          "type": "string",
          "default": "#ea3e35"
        },
        "pin": {
          "type": "boolean",
          "default": false
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "surface": {
          "type": "string",
          "default": null
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "traits": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
            "additionalProperties": true
          },
          "example": [{
            "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
          }]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Text Delete

Delete the specified text element from the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/text/<text_id>
HTTP Method: DELETE
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
text_id string Required The Unique ID of the text element

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Traits List

Get a list of traits in the object.

Details

Path: /v1/workspaces/<workspace_id>/elements/<object_type>/<object_id>/traits
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
object_type string Required Object type that can have traits associated with it Allowed values:
 - "text"
 - "notes"
 - "documents"
 - "canvas"
 - "images"
 - "browsers"
 - "strokes"
object_id string Required Unique ID of the object that can have traits associated with it

Response Schema

{
  "type": "object",
  "properties": {
    "traits": {
      "type": "array",
      "items": {
        "type": "array",
        "items": {
          "type": "object",
          "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
          "additionalProperties": true
        },
        "example": [{
          "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
        }]
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Create Traits

Create a traits in the object, or add traits to the list of already existing traits in the object. See more details in the Traits API page.

Details

Path: /v1/workspaces/<workspace_id>/elements/<object_type>/<object_id>/traits
HTTP Method: POST
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
object_type string Required Object type that can have traits associated with it Allowed values:
 - "text"
 - "notes"
 - "documents"
 - "canvas"
 - "images"
 - "browsers"
 - "strokes"
object_id string Required Unique ID of the object that can have traits associated with it

Body

{
  "type": "array",
  "items": {
    "type": "object",
    "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
    "additionalProperties": true
  }
}

Response Schema

{
  "type": "array",
  "items": {
    "type": "object",
    "description": "JSON-LD-conforming JSON document containing arbitrary persistent metadata",
    "additionalProperties": true
  },
  "example": [{
    "http://acme.com/bluescape#assetId": "905AF9EC-671E-4EA0-816C-5334D42ECE06"
  }]
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Get all Users

Get all users in the application. Require Manage Application Users permission group.

Details

Path: /v1/users
HTTP Method: GET
Authorization: Bearer Token
Parameters: query

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Query

Name Type Required? Description
query string Optional Search query
order_by string Optional Order by fields
order_direction string Optional ASC or DESC Allowed values:
 - "ASC"
 - "DESC"
filter_by string Optional Filter by field
limit integer Optional limit
offset integer Optional offset
is_organization boolean Required is_organization
exclude_guest boolean Required exclude_guest

Response Schema

{
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "email": {
            "type": "string"
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "industry": {
            "type": "string"
          },
          "phone_number": {
            "type": "string"
          },
          "locked_at": {
            "type": "string",
            "format": "date-time"
          },
          "archived": {
            "type": "boolean"
          },
          "avatar_url": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          },
          "application_role": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "is_default": {
                "type": "boolean"
              },
              "display_order": {
                "type": "integer"
              },
              "can_list_users": {
                "type": "boolean"
              },
              "can_list_organizations": {
                "type": "boolean"
              },
              "can_create_organizations": {
                "type": "boolean"
              },
              "can_edit_organizations": {
                "type": "boolean"
              },
              "can_delete_organizations": {
                "type": "boolean"
              },
              "can_edit_users": {
                "type": "boolean"
              },
              "can_list_walls": {
                "type": "boolean"
              },
              "can_create_walls": {
                "type": "boolean"
              },
              "can_edit_walls": {
                "type": "boolean"
              },
              "can_delete_walls": {
                "type": "boolean"
              },
              "can_list_plans": {
                "type": "boolean"
              },
              "can_create_plans": {
                "type": "boolean"
              },
              "can_edit_plans": {
                "type": "boolean"
              },
              "can_delete_plans": {
                "type": "boolean"
              },
              "can_lock_users": {
                "type": "boolean"
              },
              "can_lock_organizations": {
                "type": "boolean"
              },
              "can_delete_users": {
                "type": "boolean"
              },
              "can_create_help_menu": {
                "type": "boolean"
              },
              "can_edit_help_menu": {
                "type": "boolean"
              },
              "can_delete_help_menu": {
                "type": "boolean"
              },
              "can_list_saml_providers": {
                "type": "boolean"
              },
              "can_create_saml_providers": {
                "type": "boolean"
              },
              "can_edit_saml_providers": {
                "type": "boolean"
              },
              "can_delete_saml_providers": {
                "type": "boolean"
              },
              "can_create_broadcast_messages": {
                "type": "boolean"
              },
              "can_edit_broadcast_messages": {
                "type": "boolean"
              },
              "can_delete_broadcast_messages": {
                "type": "boolean"
              },
              "can_create_permission_groups": {
                "type": "boolean"
              },
              "can_delete_permission_groups": {
                "type": "boolean"
              },
              "can_edit_permission_groups": {
                "type": "boolean"
              },
              "can_list_application_roles": {
                "type": "boolean"
              },
              "can_trigger_webhook": {
                "type": "boolean"
              }
            },
            "required": ["id", "name"]
          },
          "last_login_at": {
            "type": "string",
            "format": "date-time"
          },
          "organizations": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                }
              }
            }
          },
          "user_preference": {
            "type": "object",
            "properties": {
              "notify_on_new_message": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "size": {
      "type": "integer"
    },
    "paging": {
      "type": "object",
      "properties": {
        "prev": {
          "type": "string"
        },
        "self": {
          "type": "string"
        },
        "next": {
          "type": "string"
        }
      }
    }
  },
  "required": ["users", "total", "limit", "offset", "size", "paging"]
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
500 Internal Server Error

Get a User

Get a user by its user id. Require User Authentication OR Manage Application Users permission group.

Details

Path: /v1/users/<user_id>
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
user_id integer Required User id

Response Schema

{
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "email": {
          "type": "string"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "industry": {
          "type": "string"
        },
        "phone_number": {
          "type": "string"
        },
        "locked_at": {
          "type": "string",
          "format": "date-time"
        },
        "archived": {
          "type": "boolean"
        },
        "avatar_url": {
          "type": "string"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time"
        },
        "application_role": {
          "type": "object",
          "properties": {
            "id": {
              "type": "integer"
            },
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "type": {
              "type": "string"
            },
            "is_default": {
              "type": "boolean"
            },
            "display_order": {
              "type": "integer"
            },
            "can_list_users": {
              "type": "boolean"
            },
            "can_list_organizations": {
              "type": "boolean"
            },
            "can_create_organizations": {
              "type": "boolean"
            },
            "can_edit_organizations": {
              "type": "boolean"
            },
            "can_delete_organizations": {
              "type": "boolean"
            },
            "can_edit_users": {
              "type": "boolean"
            },
            "can_list_walls": {
              "type": "boolean"
            },
            "can_create_walls": {
              "type": "boolean"
            },
            "can_edit_walls": {
              "type": "boolean"
            },
            "can_delete_walls": {
              "type": "boolean"
            },
            "can_list_plans": {
              "type": "boolean"
            },
            "can_create_plans": {
              "type": "boolean"
            },
            "can_edit_plans": {
              "type": "boolean"
            },
            "can_delete_plans": {
              "type": "boolean"
            },
            "can_lock_users": {
              "type": "boolean"
            },
            "can_lock_organizations": {
              "type": "boolean"
            },
            "can_delete_users": {
              "type": "boolean"
            },
            "can_create_help_menu": {
              "type": "boolean"
            },
            "can_edit_help_menu": {
              "type": "boolean"
            },
            "can_delete_help_menu": {
              "type": "boolean"
            },
            "can_list_saml_providers": {
              "type": "boolean"
            },
            "can_create_saml_providers": {
              "type": "boolean"
            },
            "can_edit_saml_providers": {
              "type": "boolean"
            },
            "can_delete_saml_providers": {
              "type": "boolean"
            },
            "can_create_broadcast_messages": {
              "type": "boolean"
            },
            "can_edit_broadcast_messages": {
              "type": "boolean"
            },
            "can_delete_broadcast_messages": {
              "type": "boolean"
            },
            "can_create_permission_groups": {
              "type": "boolean"
            },
            "can_delete_permission_groups": {
              "type": "boolean"
            },
            "can_edit_permission_groups": {
              "type": "boolean"
            },
            "can_list_application_roles": {
              "type": "boolean"
            },
            "can_trigger_webhook": {
              "type": "boolean"
            }
          },
          "required": ["id", "name"]
        },
        "last_login_at": {
          "type": "string",
          "format": "date-time"
        },
        "organizations": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              }
            }
          }
        },
        "user_preference": {
          "type": "object",
          "properties": {
            "notify_on_new_message": {
              "type": "boolean"
            }
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
404 Resource Not Found
500 Internal Server Error

Update a User

Update user metadata by user id. Require User Authentication OR Manage Application Users permission group.

Details

Path: /v1/users/<user_id>
HTTP Method: PUT
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
user_id integer Required User id

Body

Name Type Required? Default Description
application_role_id integer Optional
first_name string Optional
last_name string Optional
email string Optional
new_password string Optional
current_password string Optional
user_preference object Optional

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
404 Resource Not Found
500 Internal Server Error

Get User's Organizations

Get all organizations of a user by user id. Require User Authentication OR Manage Application Organizations permission group.

Details

Path: /v1/users/<user_id>/organizations
HTTP Method: GET
Authorization: Bearer Token
Parameters: path query

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
user_id integer Required User id

Query

Name Type Required? Description
query string Optional Search query
order_by string Optional Order by fields
order_direction string Optional ASC or DESC Allowed values:
 - "ASC"
 - "DESC"
limit integer Optional limit
offset integer Optional offset

Response Schema

{
  "type": "object",
  "properties": {
    "organizations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "locked_at": {
            "type": "string",
            "format": "date-time"
          },
          "account_id": {
            "type": "integer"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          },
          "expiration": {
            "type": "string",
            "format": "date-time"
          },
          "is_guest_invite_requires_approval": {
            "type": "boolean",
            "default": false
          },
          "is_cam_enabled": {
            "type": "boolean",
            "default": false
          },
          "denyOnNoCamData": {
            "type": "boolean",
            "default": true
          },
          "organization_role": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "is_default": {
                "type": "boolean"
              },
              "display_order": {
                "type": "integer"
              },
              "organization_id": {
                "type": "integer"
              },
              "is_custom": {
                "type": "boolean"
              },
              "can_add_user": {
                "type": "boolean"
              },
              "can_remove_user": {
                "type": "boolean"
              },
              "can_edit_user_info": {
                "type": "boolean"
              },
              "can_list_organization_users": {
                "type": "boolean"
              },
              "can_add_admin": {
                "type": "boolean"
              },
              "can_remove_admin": {
                "type": "boolean"
              },
              "can_edit_admin_info": {
                "type": "boolean"
              },
              "can_add_guest": {
                "type": "boolean"
              },
              "can_remove_guest": {
                "type": "boolean"
              },
              "can_edit_guest_info": {
                "type": "boolean"
              },
              "can_create_workspace": {
                "type": "boolean"
              },
              "can_view_public_workspace": {
                "type": "boolean"
              },
              "can_approve_guest_invite": {
                "type": "boolean"
              },
              "can_change_organization_settings": {
                "type": "boolean"
              },
              "can_add_organization_role": {
                "type": "boolean"
              },
              "can_edit_organization_role": {
                "type": "boolean"
              },
              "can_delete_organization_role": {
                "type": "boolean"
              },
              "can_add_workspace_role": {
                "type": "boolean"
              },
              "can_edit_workspace_role": {
                "type": "boolean"
              },
              "can_delete_workspace_role": {
                "type": "boolean"
              },
              "can_change_admin_role": {
                "type": "boolean"
              },
              "can_change_user_role": {
                "type": "boolean"
              },
              "can_change_guest_role": {
                "type": "boolean"
              },
              "can_upgrade_guest_to_user": {
                "type": "boolean"
              },
              "can_downgrade_user_to_guest": {
                "type": "boolean"
              },
              "can_upgrade_user_to_admin": {
                "type": "boolean"
              },
              "can_downgrade_admin_to_user": {
                "type": "boolean"
              },
              "can_list_organization_roles": {
                "type": "boolean"
              },
              "can_list_workspace_roles": {
                "type": "boolean"
              },
              "can_upgrade_guest_to_admin": {
                "type": "boolean"
              },
              "can_downgrade_admin_to_guest": {
                "type": "boolean"
              }
            },
            "required": ["id", "name"]
          },
          "plan": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "size": {
      "type": "integer"
    },
    "paging": {
      "type": "object",
      "properties": {
        "prev": {
          "type": "string"
        },
        "self": {
          "type": "string"
        },
        "next": {
          "type": "string"
        }
      }
    }
  },
  "required": ["organizations", "total", "limit", "offset", "size", "paging"]
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
500 Internal Server Error

Get User's Workspaces in an Organization

Get all the workspaces of a user in an organization. Require User Authentication.

Details

Path: /v1/users/<user_id>/organizations/<organization_id>/workspaces
HTTP Method: GET
Authorization: Bearer Token
Parameters: path query

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
user_id integer Required User id
organization_id integer Required Organization id

Query

Name Type Required? Description
query string Optional Search query
order_by string Optional Order by fields
order_direction string Optional ASC or DESC Allowed values:
 - "ASC"
 - "DESC"
limit integer Optional limit
offset integer Optional offset

Response Schema

{
  "type": "object",
  "properties": {
    "workspaces": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "uid": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "organization_id": {
            "type": "integer"
          },
          "public": {
            "type": "boolean"
          },
          "published_at": {
            "type": "string",
            "format": "date-time"
          },
          "published_url": {
            "type": "string"
          },
          "publish_state": {
            "type": "string"
          },
          "publish_state_at": {
            "type": "string",
            "format": "date-time"
          },
          "classification": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          },
          "workspace_role": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "is_default": {
                "type": "boolean"
              },
              "display_order": {
                "type": "integer"
              },
              "organization_id": {
                "type": "integer"
              },
              "is_custom": {
                "type": "boolean"
              },
              "is_saml": {
                "type": "boolean"
              },
              "can_edit_workspace_settings": {
                "type": "boolean"
              },
              "can_edit_workspace_content": {
                "type": "boolean"
              },
              "can_duplicate_workspace": {
                "type": "boolean"
              },
              "can_delete_workspace": {
                "type": "boolean"
              },
              "can_add_user": {
                "type": "boolean"
              },
              "can_remove_user": {
                "type": "boolean"
              },
              "can_add_guest": {
                "type": "boolean"
              },
              "can_remove_guest": {
                "type": "boolean"
              },
              "can_send_to_wall": {
                "type": "boolean"
              },
              "can_change_publish_state": {
                "type": "boolean"
              },
              "can_change_public_state": {
                "type": "boolean"
              },
              "can_download_assets": {
                "type": "boolean"
              },
              "can_change_user_role": {
                "type": "boolean"
              },
              "can_change_owner": {
                "type": "boolean"
              },
              "can_change_organization": {
                "type": "boolean"
              },
              "can_list_collaborators": {
                "type": "boolean"
              },
              "can_send_message": {
                "type": "boolean"
              },
              "can_view_workspace_settings": {
                "type": "boolean"
              },
              "can_comment": {
                "type": "boolean"
              },
              "can_at_mention": {
                "type": "boolean"
              },
              "can_view_workspace_content": {
                "type": "boolean"
              },
              "can_export_workspace": {
                "type": "boolean"
              },
              "can_import_workspace": {
                "type": "boolean"
              }
            },
            "required": ["id", "name"]
          },
          "workspace_owner": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "email": {
                "type": "string"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "title": {
                "type": "string"
              },
              "industry": {
                "type": "string"
              },
              "phone_number": {
                "type": "string"
              },
              "avatar_url": {
                "type": "string"
              },
              "locked_at": {
                "type": "string",
                "format": "date-time"
              },
              "created_at": {
                "type": "string",
                "format": "date-time"
              },
              "updated_at": {
                "type": "string",
                "format": "date-time"
              }
            }
          },
          "users_count": {
            "type": "integer"
          },
          "active_users_count": {
            "type": "integer"
          },
          "favorite": {
            "type": "boolean"
          }
        }
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "size": {
      "type": "integer"
    },
    "paging": {
      "type": "object",
      "properties": {
        "prev": {
          "type": "string"
        },
        "self": {
          "type": "string"
        },
        "next": {
          "type": "string"
        }
      }
    }
  },
  "required": ["workspaces", "total", "limit", "offset", "size", "paging"]
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
500 Internal Server Error

Get User's Workspaces

Get all the workspaces of a user. Require User Authentication.

Details

Path: /v1/users/<user_id>/workspaces
HTTP Method: GET
Authorization: Bearer Token
Parameters: path query

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
user_id integer Required User id

Query

Name Type Required? Description
query string Optional Search query
order_by string Optional Order by fields
order_direction string Optional ASC or DESC Allowed values:
 - "ASC"
 - "DESC"
limit integer Optional limit
offset integer Optional offset

Response Schema

{
  "type": "object",
  "properties": {
    "workspaces": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "uid": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "organization_id": {
            "type": "integer"
          },
          "public": {
            "type": "boolean"
          },
          "published_at": {
            "type": "string",
            "format": "date-time"
          },
          "published_url": {
            "type": "string"
          },
          "publish_state": {
            "type": "string"
          },
          "publish_state_at": {
            "type": "string",
            "format": "date-time"
          },
          "classification": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          },
          "workspace_role": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "is_default": {
                "type": "boolean"
              },
              "display_order": {
                "type": "integer"
              },
              "organization_id": {
                "type": "integer"
              },
              "is_custom": {
                "type": "boolean"
              },
              "is_saml": {
                "type": "boolean"
              },
              "can_edit_workspace_settings": {
                "type": "boolean"
              },
              "can_edit_workspace_content": {
                "type": "boolean"
              },
              "can_duplicate_workspace": {
                "type": "boolean"
              },
              "can_delete_workspace": {
                "type": "boolean"
              },
              "can_add_user": {
                "type": "boolean"
              },
              "can_remove_user": {
                "type": "boolean"
              },
              "can_add_guest": {
                "type": "boolean"
              },
              "can_remove_guest": {
                "type": "boolean"
              },
              "can_send_to_wall": {
                "type": "boolean"
              },
              "can_change_publish_state": {
                "type": "boolean"
              },
              "can_change_public_state": {
                "type": "boolean"
              },
              "can_download_assets": {
                "type": "boolean"
              },
              "can_change_user_role": {
                "type": "boolean"
              },
              "can_change_owner": {
                "type": "boolean"
              },
              "can_change_organization": {
                "type": "boolean"
              },
              "can_list_collaborators": {
                "type": "boolean"
              },
              "can_send_message": {
                "type": "boolean"
              },
              "can_view_workspace_settings": {
                "type": "boolean"
              },
              "can_comment": {
                "type": "boolean"
              },
              "can_at_mention": {
                "type": "boolean"
              },
              "can_view_workspace_content": {
                "type": "boolean"
              },
              "can_export_workspace": {
                "type": "boolean"
              },
              "can_import_workspace": {
                "type": "boolean"
              }
            },
            "required": ["id", "name"]
          },
          "workspace_owner": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "email": {
                "type": "string"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "title": {
                "type": "string"
              },
              "industry": {
                "type": "string"
              },
              "phone_number": {
                "type": "string"
              },
              "avatar_url": {
                "type": "string"
              },
              "locked_at": {
                "type": "string",
                "format": "date-time"
              },
              "created_at": {
                "type": "string",
                "format": "date-time"
              },
              "updated_at": {
                "type": "string",
                "format": "date-time"
              }
            }
          },
          "users_count": {
            "type": "integer"
          },
          "active_users_count": {
            "type": "integer"
          },
          "favorite": {
            "type": "boolean"
          }
        }
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "size": {
      "type": "integer"
    },
    "paging": {
      "type": "object",
      "properties": {
        "prev": {
          "type": "string"
        },
        "self": {
          "type": "string"
        },
        "next": {
          "type": "string"
        }
      }
    }
  },
  "required": ["workspaces", "total", "limit", "offset", "size", "paging"]
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
500 Internal Server Error

Update Session User's Application Role

Update the application role for the current session user.

Details

Path: /v1/users/me
HTTP Method: PUT
Accepted content types: application/json
Authorization: Bearer Token
Parameters:

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Body

Name Type Required? Default Description
first_name string Optional
last_name string Optional
email string Optional
new_password string Optional
current_password string Optional
user_preference object Optional

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
404 Resource Not Found
500 Internal Server Error

Get Session User's Organizations

Get all organizations of the current session user.

Details

Path: /v1/users/me/organizations
HTTP Method: GET
Authorization: Bearer Token
Parameters: query

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Query

Name Type Required? Description
query string Optional Search query
order_by string Optional Order by fields
order_direction string Optional ASC or DESC Allowed values:
 - "ASC"
 - "DESC"
limit integer Optional limit
offset integer Optional offset

Response Schema

{
  "type": "object",
  "properties": {
    "organizations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "locked_at": {
            "type": "string",
            "format": "date-time"
          },
          "account_id": {
            "type": "integer"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          },
          "expiration": {
            "type": "string",
            "format": "date-time"
          },
          "is_guest_invite_requires_approval": {
            "type": "boolean",
            "default": false
          },
          "is_cam_enabled": {
            "type": "boolean",
            "default": false
          },
          "denyOnNoCamData": {
            "type": "boolean",
            "default": true
          },
          "organization_role": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "is_default": {
                "type": "boolean"
              },
              "display_order": {
                "type": "integer"
              },
              "organization_id": {
                "type": "integer"
              },
              "is_custom": {
                "type": "boolean"
              },
              "can_add_user": {
                "type": "boolean"
              },
              "can_remove_user": {
                "type": "boolean"
              },
              "can_edit_user_info": {
                "type": "boolean"
              },
              "can_list_organization_users": {
                "type": "boolean"
              },
              "can_add_admin": {
                "type": "boolean"
              },
              "can_remove_admin": {
                "type": "boolean"
              },
              "can_edit_admin_info": {
                "type": "boolean"
              },
              "can_add_guest": {
                "type": "boolean"
              },
              "can_remove_guest": {
                "type": "boolean"
              },
              "can_edit_guest_info": {
                "type": "boolean"
              },
              "can_create_workspace": {
                "type": "boolean"
              },
              "can_view_public_workspace": {
                "type": "boolean"
              },
              "can_approve_guest_invite": {
                "type": "boolean"
              },
              "can_change_organization_settings": {
                "type": "boolean"
              },
              "can_add_organization_role": {
                "type": "boolean"
              },
              "can_edit_organization_role": {
                "type": "boolean"
              },
              "can_delete_organization_role": {
                "type": "boolean"
              },
              "can_add_workspace_role": {
                "type": "boolean"
              },
              "can_edit_workspace_role": {
                "type": "boolean"
              },
              "can_delete_workspace_role": {
                "type": "boolean"
              },
              "can_change_admin_role": {
                "type": "boolean"
              },
              "can_change_user_role": {
                "type": "boolean"
              },
              "can_change_guest_role": {
                "type": "boolean"
              },
              "can_upgrade_guest_to_user": {
                "type": "boolean"
              },
              "can_downgrade_user_to_guest": {
                "type": "boolean"
              },
              "can_upgrade_user_to_admin": {
                "type": "boolean"
              },
              "can_downgrade_admin_to_user": {
                "type": "boolean"
              },
              "can_list_organization_roles": {
                "type": "boolean"
              },
              "can_list_workspace_roles": {
                "type": "boolean"
              },
              "can_upgrade_guest_to_admin": {
                "type": "boolean"
              },
              "can_downgrade_admin_to_guest": {
                "type": "boolean"
              }
            },
            "required": ["id", "name"]
          },
          "plan": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "size": {
      "type": "integer"
    },
    "paging": {
      "type": "object",
      "properties": {
        "prev": {
          "type": "string"
        },
        "self": {
          "type": "string"
        },
        "next": {
          "type": "string"
        }
      }
    }
  },
  "required": ["organizations", "total", "limit", "offset", "size", "paging"]
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
500 Internal Server Error

Get Session User's Workspaces

Get all the workspaces of the current session user. Require User Authentication

Details

Path: /v1/users/me/workspaces
HTTP Method: GET
Authorization: Bearer Token
Parameters: query

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Query

Name Type Required? Description
query string Optional Search query
order_by string Optional Order by fields
order_direction string Optional ASC or DESC Allowed values:
 - "ASC"
 - "DESC"
limit integer Optional limit
offset integer Optional offset

Response Schema

{
  "type": "object",
  "properties": {
    "workspaces": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "uid": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "organization_id": {
            "type": "integer"
          },
          "public": {
            "type": "boolean"
          },
          "published_at": {
            "type": "string",
            "format": "date-time"
          },
          "published_url": {
            "type": "string"
          },
          "publish_state": {
            "type": "string"
          },
          "publish_state_at": {
            "type": "string",
            "format": "date-time"
          },
          "classification": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          },
          "workspace_role": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "is_default": {
                "type": "boolean"
              },
              "display_order": {
                "type": "integer"
              },
              "organization_id": {
                "type": "integer"
              },
              "is_custom": {
                "type": "boolean"
              },
              "is_saml": {
                "type": "boolean"
              },
              "can_edit_workspace_settings": {
                "type": "boolean"
              },
              "can_edit_workspace_content": {
                "type": "boolean"
              },
              "can_duplicate_workspace": {
                "type": "boolean"
              },
              "can_delete_workspace": {
                "type": "boolean"
              },
              "can_add_user": {
                "type": "boolean"
              },
              "can_remove_user": {
                "type": "boolean"
              },
              "can_add_guest": {
                "type": "boolean"
              },
              "can_remove_guest": {
                "type": "boolean"
              },
              "can_send_to_wall": {
                "type": "boolean"
              },
              "can_change_publish_state": {
                "type": "boolean"
              },
              "can_change_public_state": {
                "type": "boolean"
              },
              "can_download_assets": {
                "type": "boolean"
              },
              "can_change_user_role": {
                "type": "boolean"
              },
              "can_change_owner": {
                "type": "boolean"
              },
              "can_change_organization": {
                "type": "boolean"
              },
              "can_list_collaborators": {
                "type": "boolean"
              },
              "can_send_message": {
                "type": "boolean"
              },
              "can_view_workspace_settings": {
                "type": "boolean"
              },
              "can_comment": {
                "type": "boolean"
              },
              "can_at_mention": {
                "type": "boolean"
              },
              "can_view_workspace_content": {
                "type": "boolean"
              },
              "can_export_workspace": {
                "type": "boolean"
              },
              "can_import_workspace": {
                "type": "boolean"
              }
            },
            "required": ["id", "name"]
          },
          "workspace_owner": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "email": {
                "type": "string"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "title": {
                "type": "string"
              },
              "industry": {
                "type": "string"
              },
              "phone_number": {
                "type": "string"
              },
              "avatar_url": {
                "type": "string"
              },
              "locked_at": {
                "type": "string",
                "format": "date-time"
              },
              "created_at": {
                "type": "string",
                "format": "date-time"
              },
              "updated_at": {
                "type": "string",
                "format": "date-time"
              }
            }
          },
          "users_count": {
            "type": "integer"
          },
          "active_users_count": {
            "type": "integer"
          },
          "favorite": {
            "type": "boolean"
          }
        }
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "size": {
      "type": "integer"
    },
    "paging": {
      "type": "object",
      "properties": {
        "prev": {
          "type": "string"
        },
        "self": {
          "type": "string"
        },
        "next": {
          "type": "string"
        }
      }
    }
  },
  "required": ["workspaces", "total", "limit", "offset", "size", "paging"]
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
500 Internal Server Error

Videos List

Get list of videos in the workspace.

Details

Path: /v1/workspaces/<workspace_id>/elements/videos
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace

Response Schema

{
  "type": "object",
  "properties": {
    "videos": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "507f191e810c19729de860ea"
          },
          "workspace_id": {
            "type": "string"
          },
          "x": {
            "type": "integer",
            "default": 0
          },
          "y": {
            "type": "integer",
            "default": 0
          },
          "width": {
            "type": "integer"
          },
          "height": {
            "type": "integer"
          },
          "title": {
            "type": "string",
            "example": "Text"
          },
          "order": {
            "type": "integer",
            "default": 0
          },
          "adhesions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "text": {
                  "type": "string"
                },
                "parentId": {
                  "type": "string"
                },
                "actorType": {
                  "type": "string"
                },
                "actorId": {
                  "type": "string"
                },
                "date": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Get video details by Id

Get video details by Id.

Details

Path: /v1/workspaces/<workspace_id>/elements/videos/<video_id>
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required The Unique ID of the workspace
video_id string Required The Unique ID of the video element

Response Schema

{
  "type": "object",
  "properties": {
    "video": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "507f191e810c19729de860ea"
        },
        "workspace_id": {
          "type": "string"
        },
        "x": {
          "type": "integer",
          "default": 0
        },
        "y": {
          "type": "integer",
          "default": 0
        },
        "width": {
          "type": "integer"
        },
        "height": {
          "type": "integer"
        },
        "title": {
          "type": "string",
          "example": "Text"
        },
        "order": {
          "type": "integer",
          "default": 0
        },
        "adhesions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "parentId": {
                "type": "string"
              },
              "actorType": {
                "type": "string"
              },
              "actorId": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Create a Workspace.

Create a new workspace in an organization. Require Create Workspace permission group.

Details

Path: /v1/organizations/<organization_id>/workspaces
HTTP Method: POST
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
organization_id integer Required Organization id

Body

Name Type Required? Default Description
name string Required
description string Optional
public boolean Optional false
default_role_id integer Optional
users array Optional

Response Schema

{
  "type": "object",
  "properties": {
    "workspace": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "uid": {
          "type": "string"
        },
        "publish_state": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "organization_id": {
          "type": "integer"
        },
        "public": {
          "type": "boolean"
        },
        "default_role_id": {
          "type": "integer"
        },
        "users": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "user_id": {
                "type": "integer"
              },
              "workspace_id": {
                "type": "integer"
              },
              "workspace_role_id": {
                "type": "integer"
              },
              "created_at": {
                "type": "string",
                "format": "date-time"
              },
              "updated_at": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time"
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
500 Internal Server Error

Get a Workspace

Get workspace by workspace id or uid. Require the user is a member of workspace OR can use Wall Access Token.

Details

Path: /v1/workspaces/<workspace_id>
HTTP Method: GET
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required Workspace id

Response Schema

{
  "type": "object",
  "properties": {
    "workspace": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "uid": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "organization_id": {
          "type": "integer"
        },
        "public": {
          "type": "boolean"
        },
        "default_role_id": {
          "type": "integer"
        },
        "published_at": {
          "type": "string",
          "format": "date-time"
        },
        "published_url": {
          "type": "string"
        },
        "publish_state": {
          "type": "string"
        },
        "publish_state_at": {
          "type": "string",
          "format": "date-time"
        },
        "classification": {
          "type": "string"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time"
        },
        "workspace_role": {
          "type": "object",
          "properties": {
            "id": {
              "type": "integer"
            },
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "type": {
              "type": "string"
            },
            "is_default": {
              "type": "boolean"
            },
            "display_order": {
              "type": "integer"
            },
            "organization_id": {
              "type": "integer"
            },
            "is_custom": {
              "type": "boolean"
            },
            "is_saml": {
              "type": "boolean"
            },
            "can_edit_workspace_settings": {
              "type": "boolean"
            },
            "can_edit_workspace_content": {
              "type": "boolean"
            },
            "can_duplicate_workspace": {
              "type": "boolean"
            },
            "can_delete_workspace": {
              "type": "boolean"
            },
            "can_add_user": {
              "type": "boolean"
            },
            "can_remove_user": {
              "type": "boolean"
            },
            "can_add_guest": {
              "type": "boolean"
            },
            "can_remove_guest": {
              "type": "boolean"
            },
            "can_send_to_wall": {
              "type": "boolean"
            },
            "can_change_publish_state": {
              "type": "boolean"
            },
            "can_change_public_state": {
              "type": "boolean"
            },
            "can_download_assets": {
              "type": "boolean"
            },
            "can_change_user_role": {
              "type": "boolean"
            },
            "can_change_owner": {
              "type": "boolean"
            },
            "can_change_organization": {
              "type": "boolean"
            },
            "can_list_collaborators": {
              "type": "boolean"
            },
            "can_send_message": {
              "type": "boolean"
            },
            "can_view_workspace_settings": {
              "type": "boolean"
            },
            "can_comment": {
              "type": "boolean"
            },
            "can_at_mention": {
              "type": "boolean"
            },
            "can_view_workspace_content": {
              "type": "boolean"
            },
            "can_export_workspace": {
              "type": "boolean"
            },
            "can_import_workspace": {
              "type": "boolean"
            }
          },
          "required": ["id", "name"]
        }
      }
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
500 Internal Server Error

Update a Workspace

Update the metadata of a workspace. Based on the update target field, require Edit Workspace Settings or Manage Workspace permission group.

Details

Path: /v1/workspaces/<workspace_id>
HTTP Method: PUT
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required Workspace id

Body

Name Type Required? Default Description
name string Optional
description string Optional
public boolean Optional
default_role_id integer Optional
user_id integer Optional

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
404 Resource Not Found
500 Internal Server Error

Delete a Workspace

Delete a workspace temporarily or permanently. Require Manage Workspace permission group.

Details

Path: /v1/workspaces/<workspace_id>
HTTP Method: DELETE
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required Workspace id

Body

Name Type Required? Default Description
is_permanent boolean Optional false

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
500 Internal Server Error

Get Active Users in a Workspace

Get users currently active in the specified workspace. Supported `query` fields: `email`, `first_name`, `last_name`. The value of `query` will be searched against all of these fields. Supported `order_by` fields: `id`, `email`, `first_name`, `last_name`.

Details

Path: /v1/workspaces/<workspace_id>/active_users
HTTP Method: GET
Authorization: Bearer Token
Parameters: path query

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required Workspace id

Query

Name Type Required? Description
query string Optional Search query
order_by string Optional Order by fields
order_direction string Optional ASC or DESC Allowed values:
 - "ASC"
 - "DESC"
limit integer Optional limit
offset integer Optional offset

Response Schema

{
  "type": "object",
  "properties": {
    "active_users": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "type": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "leader": {
            "type": "boolean"
          }
        },
        "required": ["id", "email", "first_name", "last_name", "leader"]
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "size": {
      "type": "integer"
    },
    "paging": {
      "type": "object",
      "properties": {
        "prev": {
          "type": "string"
        },
        "self": {
          "type": "string"
        },
        "next": {
          "type": "string"
        }
      }
    }
  },
  "required": ["active_users", "total", "limit", "offset", "size", "paging"]
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Get Workspace Users

Get all users from a specific workspace by workspace id. Require View Workspace Collaborators permission group.

Details

Path: /v1/workspaces/<workspace_id>/all_users
HTTP Method: GET
Authorization: Bearer Token
Parameters: path query

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required Workspace id/UID

Query

Name Type Required? Description
filter_by string Optional Filter by field

Response Schema

{
  "type": "object",
  "properties": {
    "workspace_users": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "email": {
            "type": "string"
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          }
        }
      }
    },
    "total": {
      "type": "integer"
    }
  },
  "required": ["workspace_users", "total"]
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
404 Resource Not Found
500 Internal Server Error

Copy a Workspace

Make a copy of a specific workspace by workspace id. Require Manage Workspace permission group.

Details

Path: /v1/workspaces/<workspace_id>/copy
HTTP Method: PUT
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required Workspace id

Body

Name Type Required? Default Description
new_workspace_name string Optional
new_workspace_description string Optional

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
404 Resource Not Found
500 Internal Server Error

Make a Workspace Favorite

Mark a specific workspace as user favorite workspace

Details

Path: /v1/workspaces/<workspace_id>/favorite
HTTP Method: POST
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required Workspace id

Body

Name Type Required? Default Description
favorite boolean Optional true

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
404 Resource Not Found
500 Internal Server Error

Publish a Workspace

Publish a workspace. Require Manage Workspace permission group.

Details

Path: /v1/workspaces/<workspace_id>/publish
HTTP Method: PUT
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required Workspace id

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
404 Resource Not Found
500 Internal Server Error

Unpublish a Workspace

Unpublish a workspace. Require Manage Workspace permission group.

Details

Path: /v1/workspaces/<workspace_id>/unpublish
HTTP Method: PUT
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required Workspace id

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
403 ForbiddenError
404 Resource Not Found
500 Internal Server Error

Add a User to a Workspace

Add a user by user id to a specific workspace by workspace id

Details

Path: /v1/workspaces/<workspace_id>/users
HTTP Method: POST
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required Workspace id

Body

Name Type Required? Default Description
users array Required array of users => email (string), workspace_role_id (string)

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
500 Internal Server Error

Update a User in a Workspace

Update a user's role in a specific workspace. Require Edit Workspace Collaborators permission group.

Details

Path: /v1/workspaces/<workspace_id>/users/<user_id>
HTTP Method: PUT
Accepted content types: application/json
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>
Content-Type string Required Value: application/json

Path

Name Type Required? Description
workspace_id string Required Workspace id
user_id integer Required User id

Body

Name Type Required? Default Description
workspace_role_id integer Required

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
500 Internal Server Error

Remove a User or Guest from a Workspace

Remove a user or guest from a workspace. Require Edit Workspace Collaborators permission group.

Details

Path: /v1/workspaces/<workspace_id>/users/<user_id>
HTTP Method: DELETE
Authorization: Bearer Token
Parameters: path

Headers

Name Type Required? Description
Authorization string Required Format: Bearer <access-token>

Path

Name Type Required? Description
workspace_id string Required Workspace id
user_id integer Required User id

Response Schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Code Description
400 Bad Request
401 Unauthorized
500 Internal Server Error