Hierarchy

  • BaseBoard
    • Board

Properties

createdAt?: Date

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

createdBy?: UserInfoShort
currentUserMembership?: BoardMember
description: string

Description of the board.

id: string
lastOpenedAt?: Date

Date and time when the board was last opened by any user. This information is only available when the boards are sorted by last_opened. Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

lastOpenedBy?: UserInfoLastOpenedBy
modifiedAt?: Date

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

modifiedBy?: UserInfoShort
name: string

Name of the board.

picture?: Picture
policy?: BoardPolicy
project?: Project
team?: Team
type: string

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

viewLink?: string

URL to view the board.

Methods

  • Retrieves a list of items for a specific board. You can retrieve all items on the board, or a list of specific types of items by specifying URL query parameter values.

    Required scope

    boards:read

    Rate limiting

    Level 2
    Returns an iterator which will automatically paginate and fetch all available items

    Summary

    Get items on board

    Parameters

    • Optional query: Omit<undefined | {
          cursor?: string;
          limit?: string;
          type?: "embed" | "frame" | "image" | "text" | "document" | "shape" | "sticky_note" | "card" | "app_card" | "preview";
      }, "cursor">

    Returns AsyncGenerator<WidgetItem, void, unknown>

  • Retrieves all the tags from the specified board.

    Required scope

    boards:read

    Rate limiting

    Level 1

    Returns an iterator which will automatically paginate and fetch all available tags

    Summary

    Get tags from board

    Returns AsyncGenerator<Tag, void, unknown>

  • Retrieves information for a specific app card item on a board.

    Required scope

    boards:read

    Rate limiting

    Level 1

    Summary

    Get app card item

    Parameters

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<AppCardItem>

  • Retrieves information for a specific card item on a board

    Required scope

    boards:read

    Rate limiting

    Level 1

    Summary

    Get card item

    Parameters

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<CardItem>

  • Retrieves information for a specific connector on a board.

    Required scope

    boards:read

    Rate limiting

    Level 1

    Summary

    Get specific connector

    Parameters

    • connectorId: string

      Unique identifier (ID) of the connector that you want to retrieve.

    Returns Promise<Connector>

  • Retrieves information for a specific document item on a board

    Required scope

    boards:read

    Rate limiting

    Level 1

    Summary

    Get document item

    Parameters

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<DocumentItem>

  • Retrieves information for a specific embed item on a board.

    Required scope

    boards:read

    Rate limiting

    Level 1

    Summary

    Get embed item

    Parameters

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<EmbedItem>

  • Retrieves information for a specific frame on a board.

    Required scope

    boards:read

    Rate limiting

    Level 1

    Summary

    Get frame

    Parameters

    • itemId: string

      Unique identifier (ID) of the frame that you want to retrieve.

    Returns Promise<FrameItem>

  • Retrieves information for a specific image item on a board.

    Required scope

    boards:read

    Rate limiting

    Level 1

    Summary

    Get image item

    Parameters

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<ImageItem>

  • Retrieves information for a board member.

    Required scope

    boards:read

    Rate limiting

    Level 1

    Summary

    Get specific board member

    Parameters

    • boardMemberId: string

      Unique identifier (ID) of the board member whose role you want to retrieve.

    Returns Promise<BoardMember>

  • Retrieves information for a specific shape item on a board.

    Required scope

    boards:read

    Rate limiting

    Level 1

    Summary

    Get shape item

    Parameters

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<ShapeItem>

  • Retrieves information for a specific sticky note item on a board.

    Required scope

    boards:read

    Rate limiting

    Level 1

    Summary

    Get sticky note item

    Parameters

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<StickyNoteItem>

  • Retrieves information for a specific tag.

    Required scope

    boards:write

    Rate limiting

    Level 1

    Summary

    Get tag

    Parameters

    • tagId: string

      Unique identifier (ID) of the tag that you want to retrieve.

    Returns Promise<Tag>

  • Retrieves information for a specific text item on a board.

    Required scope

    boards:read

    Rate limiting

    Level 1

    Summary

    Get text item

    Parameters

    • itemId: string

      Unique identifier (ID) of the item that you want to retrieve.

    Returns Promise<TextItem>

  • Removes a board member from a board.

    Required scope

    boards:write

    Rate limiting

    Level 2

    Summary

    Remove board member

    Parameters

    • boardMemberId: string

      Unique identifier (ID) of the board member whose role you want to delete.

    Returns Promise<void>

  • Removes the specified tag from the specified item. The tag still exists 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, Update tag, Delete tag.

    Required scope

    boards:write

    Rate limiting

    Level 1

    Summary

    Remove tag from item

    Parameters

    • itemId: string

      Unique identifier (ID) of the item that you want to remove the tag from.

    • tagId: string

      Unique identifier (ID) of the tag that you want to remove from the item.

    Returns Promise<void>

  • Shares the board and Invites new members to collaborate on a board by sending an invitation email. Depending on the board's Sharing policy, there might be various scenarios where membership in the team is required in order to share the board with a user.

    Required scope

    boards:write

    Rate limiting

    Level 3

    Summary

    Share board

    Parameters

    Returns Promise<void>