Miro List

Miro List

Certified

List Miro boards

Returns a paginated list of boards the authenticated user can access. Optionally filter by team ID, project ID, sort order, or a search query. Returns the first page by default; use offset with limit and the total output to page through results.

yaml
type: io.kestra.plugin.miro.boards.List

List all boards in a team

yaml
id: list_miro_boards
namespace: company.team

tasks:
  - id: list
    type: io.kestra.plugin.miro.boards.List
    token: "{{ secret('MIRO_TOKEN') }}"
    teamId: "{{ secret('MIRO_TEAM_ID') }}"

List boards with offset-based pagination

yaml
id: list_miro_boards_paged
namespace: company.team

tasks:
  - id: page1
    type: io.kestra.plugin.miro.boards.List
    token: "{{ secret('MIRO_TOKEN') }}"
    teamId: "{{ secret('MIRO_TEAM_ID') }}"
    limit: 10

  - id: page2
    type: io.kestra.plugin.miro.boards.List
    token: "{{ secret('MIRO_TOKEN') }}"
    teamId: "{{ secret('MIRO_TEAM_ID') }}"
    limit: 10
    offset: 10
Properties

Miro OAuth 2.0 access token

OAuth 2.0 bearer token used to authenticate against the Miro REST API. Use {{ secret('MIRO_TOKEN') }} to avoid exposing the value in flow definitions. Tokens expire in 1 hour; non-expiring tokens are also supported for service accounts.

Default20

Limit

Maximum number of boards to return per page (1-50). Defaults to 20.

Offset

Zero-based index of the first board to return, for pagination. Combine with limit and the total output to page through results.

HTTP client configuration

Definitions
allowFailedbooleanstring
Defaultfalse

If true, allow a failed response code (response code >= 400)

allowedResponseCodesarray
SubTypeinteger

List of response code allowed for this request

auth

The authentication to use.

type*Requiredobject
passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

type*Requiredobject
tokenstring

The token for bearer token authentication.

type*Requiredobject
passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

basicAuthPasswordDeprecatedstring

The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

basicAuthUserDeprecatedstring

The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

connectTimeoutDeprecatedstring
Formatduration

The time allowed to establish a connection to the server before failing.

connectionPoolIdleTimeoutDeprecatedstring
Formatduration

The time an idle connection can remain in the client's connection pool before being closed.

defaultCharsetstring
DefaultUTF-8

The default charset for the request.

enabledTcpExtendedKeepAlivebooleanstring
Defaulttrue

Whether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).

Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.

followRedirectsbooleanstring
Defaulttrue

Whether redirects should be followed automatically.

logLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIED

The log level for the HTTP client.

logsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

maxContentLengthDeprecatedinteger

The maximum content length of the response.

proxy

The proxy configuration.

addressstring

The address of the proxy server.

passwordstring

The password for proxy authentication.

portintegerstring

The port of the proxy server.

typestring
DefaultDIRECT
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

usernamestring

The username for proxy authentication.

proxyAddressDeprecatedstring

The address of the proxy server.

proxyPasswordDeprecatedstring

The password for proxy authentication.

proxyPortDeprecatedinteger

The port of the proxy server.

proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

proxyUsernameDeprecatedstring

The username for proxy authentication.

readIdleTimeoutDeprecatedstring
Formatduration

The time allowed for a read connection to remain idle before closing it.

readTimeoutDeprecatedstring
Formatduration

The maximum time allowed for reading data from the server before failing.

ssl

The SSL request options

insecureTrustAllCertificatesbooleanstring

Whether to disable checking of the remote SSL certificate.

Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.

timeout

The timeout configuration.

connectTimeoutstring

The time allowed to establish a connection to the server before failing.

readIdleTimeoutstring
DefaultPT5M

The time allowed for a read connection to remain idle before closing it.

Owner

Filter boards by owner (user ID or email).

Reference (ref) of the pluginDefaults to apply to this task.

Project ID

Filter boards belonging to the given project.

Search query

Filter boards whose name matches this query string.

Possible Values
DEFAULTLAST_MODIFIEDLAST_OPENEDLAST_OPENED_BY_ANYONELAST_CREATEDALPHABETICALLY

Sort order

Sort order for the board list. The Miro API does not support a descending - prefix.

Team ID

Filter boards belonging to the given team.

SubTypeobject

Boards

List of boards returned by this page.

Offset

Zero-based index of the first board in this page, as echoed by the Miro API.

Size

Number of boards returned in this page.

Total

Total number of boards matching the filter (may exceed this page).

More Plugins in this Category

Zulip
Zulip

Tasks that send messages to Zulip streams or users.

Business

2 tasks

3 blueprints

Zenduty
Zenduty

Tasks that create incidents in Zenduty.

Business

2 tasks

3 blueprints