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
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
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

  • Creates a copy of an existing board. You can also update the name, description, sharing policy, and permissions policy for the new board in the request body.

    Required scope

    boards:write

    Rate limiting

    Level 4

    Summary

    Copy board

    Parameters

    Returns Promise<Board>

  • 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?: string;
      }, "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 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>

  • 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>

  • 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. For more information on sharing policy and different scenarios, see Sharing policy.

    Required scope

    boards:write

    Rate limiting

    Level 3

    Summary

    Share board

    Parameters

    Returns Promise<void>