Class MiroApi

Hierarchy

Api
- MiroApi

Index

Constructors

constructor

Methods

createBoard getAllBoards getBoard getOrganization revokeToken tokenInfo

Constructors

constructor

new MiroApi(accessToken: string | (() => Promise<string>), basePath?: string, logger?: Logger, httpTimeout?: number): MiroApi
Parameters
- accessToken: string | (() => Promise<string>)
- basePath: string = defaultBasePath
- Optional logger: Logger
- Optional httpTimeout: number
Returns MiroApi
Overrides HighlevelApi.constructor
- Defined in index.ts:209

Methods

createBoard

createBoard(boardChanges: undefined | BoardChanges): Promise<Board>
Creates a board with the specified name and sharing policies.
Required scope
boards:write
Rate limiting
Level 3

Summary
Create board
Parameters
- boardChanges: undefined | BoardChanges
Returns Promise<Board>
Inherited from Api.createBoard
- Defined in highlevel/index.ts:45

getAllBoards

getAllBoards(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">): AsyncGenerator<Board, void, unknown>
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>
Inherited from Api.getAllBoards
- Defined in highlevel/Api.ts:22

getBoard

getBoard(boardId: string): Promise<Board>
Retrieves information about a board.
Required scope
boards:read
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>
Inherited from Api.getBoard
- Defined in highlevel/index.ts:56

getOrganization

getOrganization(orgId: string): Promise<Organization>
Retrieves organization information.
Required scope
organizations:read
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>
Inherited from Api.getOrganization
- Defined in highlevel/index.ts:67

revokeToken

revokeToken(): Promise<void>
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>
Inherited from Api.revokeToken
- Defined in highlevel/Api.ts:10

tokenInfo

tokenInfo(): Promise<TokenInformation>
Get information about an access token, such as the token type, scopes, team, user, token creation date and time, and the user who created the token.

Summary
Get access token information

Returns Promise<TokenInformation>
Inherited from Api.tokenInfo
- Defined in highlevel/index.ts:77

Class MiroApi

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

accessToken: string | (() => Promise<string>)

basePath: string = defaultBasePath

Optional logger: Logger

Optional httpTimeout: number

Returns MiroApi

Methods

createBoard

Required scope

Rate limiting

Summary

Parameters

boardChanges: undefined | BoardChanges

Returns Promise<Board>

getAllBoards

Required scope

Rate limiting

Summary

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

Required scope

Rate limiting

Summary

Parameters

boardId: string

Returns Promise<Board>

getOrganization

Required scope

Rate limiting

Enterprise only

Summary

Parameters

orgId: string

Returns Promise<Organization>

revokeToken

Returns Promise<void>

tokenInfo

Summary

Returns Promise<TokenInformation>

`Optional` logger: Logger

`Optional` httpTimeout: number

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