Get specific item on board

get https://api.miro.com/v2-experimental/boards/{board_id}/items/{item_id}

Retrieves information for a specific item on a board.

Required scope

boards:read

Rate limiting

Level 1

Responses

Response body

object

createdAt

date-time

Date and time when the item was created.
Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

createdBy

object

Contains information about the user who created the item.

string

Unique identifier (ID) of the user.

type

string

Indicates the type of object returned. In this case, type returns user.

data

Contains the item data, such as the item title, content, or description.

geometry

object

Contains geometrical information about the item, such as its width or height.

height

double

Height of the item, in pixels.

rotation

double

Rotation angle of an item, in degrees, relative to the board. You can rotate items clockwise (right) and counterclockwise (left) by specifying positive and negative values, respectively.

width

double

Width of the item, in pixels.

string

required

Unique identifier (ID) of an item.

links

object

Contains applicable links for the item.

string

Link to obtain information about the child items related to the frame.

self

string

Link to obtain information about the current item.

modifiedAt

date-time

Date and time when the item was last modified.
Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

modifiedBy

object

Contains information about the user who last modified the item.

string

Unique identifier (ID) of the user.

type

string

Indicates the type of object returned. In this case, type returns user.

parent

object

Contains information about the parent for the item.

string

Unique identifier (ID) of the parent for the item.

links

object

Contains applicable links for the current object.

position

object

Contains location information about the item, such as its x coordinate, y coordinate, and the origin of the x and y coordinates.

origin

string

Defaults to center

Area of the item that is referenced by its x and y coordinates. For example, an item with a center origin will have its x and y coordinates point to its center. The center point of the board has x: 0 and y: 0 coordinates.
Currently, only one option is supported (center).

center

relativeTo

string

canvas_center parent_top_left

double

X-axis coordinate of the location of the item on the board.
By default, all items have absolute positioning to the board, not the current viewport. Default: 0.
The center point of the board has x: 0 and y: 0 coordinates.

double

Y-axis coordinate of the location of the item on the board.
By default, all items have absolute positioning to the board, not the current viewport. Default: 0.
The center point of the board has x: 0 and y: 0 coordinates.

type

string

required

Type of item that is returned.

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.miro.com/v2-experimental/boards/board_id/items/item_id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Item retrieved

400Malformed request

404Not found

429Too many requests