Skip to main content

Get mind map nodes

GET 
/v2-experimental/boards/:board_id/mindmap_nodes

Retrieves a list of mind map nodes for a specific board.

This method returns results using a cursor-based approach. A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, on your next call to the same method, set the cursor parameter equal to the cursor value you received in the response of the previous request. For example, if you set the limit query parameter to 10 and the board contains 20 objects, the first call will return information about the first 10 objects in the response along with a cursor parameter and value. In this example, let's say the cursor parameter value returned in the response is foo. If you want to retrieve the next set of objects, on your next call to the same method, set the cursor parameter value to foo.

Required scope

boards:read

Rate limiting

Level 2

Request​

Path Parameters

    board_id stringrequired

    Unique identifier (ID) of the board from which you want to retrieve mind map nodes.

Query Parameters

    limit string

    Maximum number of results returned

    cursor string

    Points to the next portion of the results set

Responses​

Mind map nodes retrieved

Schema

    data

    object[]

    Contains the result data.

  • Array [

    • id int64required

    Unique identifier (ID) of an item.

    data

    object

    Contains mind map node data, such as nodeView or isRoot.

    nodeView

    object

    Contains the information about the mind map node.

    type string

    Type of item used as mind map node. Currently, type can only be equal to text.

    data

    object

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

    oneOf

    content stringrequired

    The actual text (content) that appears in the text item.

    style

    object

    Contains information about the node style, such as the node color or fillOpacity.

    color string

    Hex value representing the color for the text within the node.

    fillOpacity string

    It sets the opacity level of the background fill color.

    Allowed values: any number between 0.0 and 1.0 included.

    If the value is 0.0, the background fill color is completely transparent or invisible. If the value is 1.0, the background fill color is completely opaque or solid. Default: 0 (transparent)

    fontSize string

    Possible values: >= 10 and <= 288

    Defines the font size, in dp, for the text on the node. Default: 14.

    isRoot boolean

    Indicates whether this node is the root of the mind map.

    direction string

    Possible values: [start, end]

    Indicates where this node is positioned relative to the root node. start indicates that this node must be positioned at the start of the root node, which is either the left or top of the root node. end indicates that this node must be positioned at the emd of the root node, which is either the right or bottom of the root node.

    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.

    id string

    Unique identifier (ID) of the user.

    type string

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

    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.

    id 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 frame for the item.

    id int64

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

    links

    object

    Contains applicable links for the current object.

    self string

    Link to obtain more information about the current object.

    links

    object

    Contains applicable links for the item.

    related string

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

    self string

    Link to obtain information about the current item.

    type stringrequired

    Type of item that is returned.

    style

    object

    Contains information about the node style, such as the widget's border color or shape type.

    nodeColor string

    Hex value representing the color of the widget's border.

    shape string

    Possible values: [pill, rectangle, rounded_rectangle, none]

    Shape type of the widget.

    fontSize string

    Possible values: >= 10 and <= 288

    The same font size as in MindmapNodeStyle.

  • ]

    • total int64

    Total number of results available. If the value of the total parameter is higher than the value of the size parameter, this means that there are more results that you can retrieve. To retrieve more results, you can make another request and set the offset value accordingly. For example, if there are 30 results, and the request has the offset set to 0 and the limit set to 20, the size parameter will return 20 and the total parameter will return 30. This means that there are 9 more results to retrieve (as the offset is zero-based).

    size int32

    Number of results returned in the response considering the cursor and the limit values sent in the request. For example, if there are 20 results, the request does not have a cursor value, and the limit set to 10, the size of the results will be 10.
    In this example, the response will also return a cursor value that can be used to retrieve the next set of 10 remaining results in the collection.'

    cursor string

    A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next set of results of the collection, set the cursor parameter in your next request to the value returned in this parameter.'

    limit int32

    Maximum number of results returned based on the limit specified in the request. For example, if there are 20 results, the request has no cursor value, and the limit is set to 20,the size of the results will be 20. The rest of the results will not be returned. To retrieve the rest of the results, you must make another request and set the appropriate value for the cursor parameter value that you obtained from the response.'

    links

    object

    Contains pagination links for the collection.

    first string

    Link to retrieve information in the first page of the collection.

    last string

    Link to the retrieve information in the last page of the collection.

    next string

    Link to retrieve information in the next page of the collection.

    prev string

    Link to retrieve information in the previous page of the collection.

    self string

    Link to retrieve information in the current page of the collection.

Loading...