Item

Overview of the data objects and properties that board items are made of.

The following table list the data objects and properties that are common to all supported board items.

Property nameProperty typeDescription
idStringUnique identifier of a item. The identifier is generated automatically upon item creation.
typeStringThe type of object that is returned. type returns the item type; for example: shape.
createdAtTimestampDate and time when the item was created. Format: UTC, adheres to ISO 8601, includes a trailing Z offset.
createdByuserContains information about the user who created the item.
datadataContains data about the item.
geometrygeometryContains information about the geometry of the item, such as the item's position on the board, width, height, and rotation angle in degrees.
modifiedAtTimestampDate and time when the item was last modified. Format: UTC, adheres to ISO 8601, includes a trailing Z offset.
modifiedByuserContains information about the user who last modified the item.
stylestyleContains information about the style of the item.
{
  "id": "3074457361093859723",
  "geometry": {
    "x": 0.0,
    "y": 0.0,
    "width": 100.0,
    "height": 100.0,
    "rotation": 0.0
  },
  "data": {
    "content": "sample shape item",
    "shapeType": "rectangle"
  },
  "style": {
    "backgroundColor": "#ffffffff",
    "backgroundOpacity": "1.0",
    "fontFamily": "OpenSans",
    "fontSize": "14",
    "borderColor": "#1a1a1a",
    "borderWidth": "2.0",
    "borderOpacity": "1.0",
    "borderStyle": "normal",
    "textAlign": "center"
  },
  "createdAt": "2021-07-07T09:16:41Z",
  "createdBy": {
    "id": "3074457349479975378",
    "type": "user"
  },
  "modifiedAt": "2021-07-07T09:16:41Z",
  "modifiedBy": {
    "id": "3074457349479975378",
    "type": "user"
  },
  "type": "shape"
}