Class Tag

Hierarchy

  • BaseTag
    • Tag

Properties

boardId fillColor id title type

Methods

delete getAllTaggedItems update

Properties

boardId

boardId: string

fillColor

fillColor: string

Background color of the tag.

id

id: string

title

title: string

Text of the tag.

type

type: string

Type of the object that is returned. In this case, type returns tag.

Methods

delete

  • Deletes the specified tag from the board. The tag is also removed from all cards and sticky notes on the board.

    Note: Updates to tags made via the REST API will not be reflected on the board in realtime. To see REST API updates to tags on a board, you need to refresh the board. This applies to the following endpoints: Attach tag to item, Remove tag from item, Update tag.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Delete tag

    Returns Promise<void>

getAllTaggedItems

  • Retrieves all the items that have the specified tag.

    Required scope

    boards:read

    Rate limiting

    Level 1
    Returns an iterator which will automatically paginate and fetch all tagged items

    Summary

    Get items by tag

    Returns AsyncGenerator<Item, void, unknown>

update

  • Updates a tag based on the data properties provided in the request body.

    Note: Updates to tags made via the REST API will not be reflected on the board in realtime. To see REST API updates to tags on a board, you need to refresh the board. This applies to the following endpoints: Attach tag to item, Remove tag from item, Delete tag.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 1

    Summary

    Update tag

    Parameters

    Returns Promise<void>

@mirohq/miro-api