Class MiroApi

Hierarchy

Constructors

constructor

Methods

createBoard getAllBoards getBoard getOrganization revokeToken tokenInfo

Constructors

constructor

  • Parameters

    • accessToken: string | (() => Promise<string>)
    • basePath: string = defaultBasePath
    • Optional logger: Logger
    • Optional httpTimeout: number

    Returns MiroApi

Methods

createBoard

  • Creates a board with the specified name and sharing policies.

    Note

    You can only create up to 3 team boards with the free plan.

    Required scope

    boards:write

    Rate limiting

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

    Summary

    Create board

    Parameters

    Returns Promise<Board>

getAllBoards

  • Retrieves all boards that match the search criteria provided in the request. If you are an Enterprise customer and a Company Admin, you can retrieve all boards, including all private boards (boards that haven't been specifically shared with you) by enabling Content Admin permissions. To enable Content Admin permissions, see https://help.miro.com/hc/en-us/articles/360012777280-Content-Admin-permissions-for-Company-Admins. Note that you only get results instantaneously when you filter by team_id. If you use any other filter, you need to give a few seconds for the indexing of newly created boards before retrieving boards.

    Required scope

    boards:read

    Rate limiting

    Level 1

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

    Summary

    Get boards

    Parameters

    • Optional query: Omit<undefined | {
          limit?: string;
          offset?: string;
          owner?: string;
          projectId?: string;
          query?: string;
          sort?: "default" | "last_modified" | "last_opened" | "last_created" | "alphabetically";
          teamId?: string;
      }, "offset">

    Returns AsyncGenerator<Board, void, unknown>

getBoard

  • Retrieves information about a board.

    Required scope

    boards:read

    Rate limiting

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

    Summary

    Get specific board

    Parameters

    • boardId: string

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

    Returns Promise<Board>

getOrganization

  • Retrieves organization information.

    Required scope

    organizations:read

    Rate limiting

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

    Enterprise only

    This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

    Summary

    Get organization info

    Parameters

    • orgId: string

      id of the organization

    Returns Promise<Organization>

revokeToken

  • Revoke the current access token. Revoking an access token means that the access token will no longer work. When an access token is revoked, the refresh token is also revoked and no longer valid. This does not uninstall the application for the user.

    Returns Promise<void>

tokenInfo

@mirohq/miro-api