API Data Provider - Online Help

Connecting to Miro

Using API Key Authentication

Miro uses API Key authentication with an access token. To generate an access token:
  1. Log in to your Miro account.
  2. Navigate to Settings > Your applications.
  3. Click "Create new application" or select an existing application.
  4. Configure the required permissions (for example, boards:read, teams:read).
  5. Install the application and generate an access token.
  6. Copy the generated access token (Miro displays the token only once).

After obtaining your access token, set the following connection properties:

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your access token.

Available Tables

The Miro API Profile provides access to the following tables:
  • Boards: Returns board information, including metadata, ownership, and permissions.
  • BoardMembers: Returns board member information and roles.
  • BoardTags: Lists tags associated with boards.
  • BoardGroups: Returns groups on specific boards.
  • BoardGroupItems: Returns items within board groups.
  • Items: Returns all board items, including widgets and shapes.
  • StickyNotes: Returns sticky note items with content and styling.
  • Cards: Returns card items with titles and descriptions.
  • Shapes: Returns shape items with geometry and styling.
  • Texts: Returns text items on boards.
  • Images: Returns image items with URLs and metadata.
  • Frames: Returns frame items and their properties.
  • FrameItems: Returns items nested within frames.
  • Documents: Returns document items (PDFs and other files).
  • DocFormats: Returns document format items with rich text content.
  • Embeds: Returns embedded content (videos, websites).
  • Connectors: Returns connector lines and arrows between items.
  • AppCards: Returns app card items with custom application data.
  • Tags: Lists all tags in the organization.
  • ItemTags: Lists tags associated with specific items.
  • ItemsByTag: Returns items filtered by specific tags.
  • Organizations: Returns organization information and plan details.
  • OrganizationMembers: Returns organization member information and roles.
  • Teams: Lists teams within organizations.
  • TeamMembers: Returns team member information and roles.
  • TeamSettings: Returns team-specific settings and configurations.
  • DefaultTeamSettings: Returns default team settings for organizations.
  • Groups: Lists user groups within organizations.
  • ScimGroups: Returns SCIM group information (SCIM API v1).
  • Projects: Returns project (space) information.
  • ProjectMembers: Returns project member information and roles.
  • ProjectSettings: Returns project-specific settings and policies.
  • AuditLogs: Returns audit log events (Enterprise organizations only).

API Documentation

For more information about the Miro API, see the official Miro API documentation.

Usage Examples

Boards:

SELECT * FROM Boards
SELECT * FROM Boards WHERE BoardId = '3074457361234567890'

BoardMembers:

SELECT * FROM BoardMembers WHERE BoardId = '3074457361234567890'

Items:

SELECT * FROM Items WHERE BoardId = '3074457361234567890'
SELECT * FROM Items WHERE BoardId = '3074457361234567890' AND Type = 'sticky_note'

StickyNotes:

SELECT * FROM StickyNotes WHERE BoardId = '3074457361234567890' AND ItemId = '3458764515687654321'

Cards:

SELECT * FROM Cards WHERE BoardId = '3074457361234567890' AND ItemId = '3458764515687654321'

Shapes:

SELECT * FROM Shapes WHERE BoardId = '3074457361234567890' AND ItemId = '3458764515687654321'

Texts:

SELECT * FROM Texts WHERE BoardId = '3074457361234567890' AND ItemId = '3458764515687654321'

Images:

SELECT * FROM Images WHERE BoardId = '3074457361234567890' AND ItemId = '3458764515687654321'

Frames:

SELECT * FROM Frames WHERE BoardId = '3074457361234567890' AND ItemId = '3458764515687654321'

FrameItems:

SELECT * FROM FrameItems WHERE BoardId = '3074457361234567890' AND ParentItemId = '3458764515687654321'

Tags:

SELECT * FROM Tags WHERE BoardId = '3074457361234567890' AND TagId = '987654321'

ItemTags:

SELECT * FROM ItemTags WHERE BoardId = '3074457361234567890' AND ItemId = '3458764515687654321'

ItemsByTag:

SELECT * FROM ItemsByTag WHERE BoardId = '3074457361234567890' AND TagId = '987654321'

BoardGroups:

SELECT * FROM BoardGroups WHERE BoardId = '3074457361234567890'

BoardGroupItems:

SELECT * FROM BoardGroupItems WHERE BoardId = '3074457361234567890' AND GroupId = '3458764515687654321'

Organizations:

SELECT * FROM Organizations WHERE OrgId = '987654321'

OrganizationMembers:

SELECT * FROM OrganizationMembers WHERE OrgId = '987654321'

Teams:

SELECT * FROM Teams WHERE OrgId = '987654321'

TeamMembers:

SELECT * FROM TeamMembers WHERE OrgId = '987654321' AND TeamId = '3074457361234567890'

Projects:

SELECT * FROM Projects WHERE OrgId = '987654321' AND TeamId = '3074457361234567890'

AuditLogs:

SELECT * FROM AuditLogs WHERE CreatedAfter = '2024-01-01T00:00:00.000Z' AND CreatedBefore = '2024-12-31T23:59:59.999Z'

Documents:

SELECT * FROM Documents WHERE BoardId = '3074457361234567890' AND ItemId = '3458764515687654321'

DocFormats:

SELECT * FROM DocFormats WHERE BoardId = '3074457361234567890' AND ItemId = '3458764515687654321'

Embeds:

SELECT * FROM Embeds WHERE BoardId = '3074457361234567890' AND ItemId = '3458764515687654321'

Connectors:

SELECT * FROM Connectors WHERE BoardId = '3074457361234567890'

AppCards:

SELECT * FROM AppCards WHERE BoardId = '3074457361234567890' AND ItemId = '3458764515687654321'

BoardTags:

SELECT * FROM BoardTags WHERE BoardId = '3074457361234567890'

Groups:

SELECT * FROM Groups WHERE OrgId = '987654321'

ScimGroups:

SELECT * FROM ScimGroups
SELECT * FROM ScimGroups WHERE Id = 'e2b3d4f5-6a78-9012-3456-789abcdef012'

TeamSettings:

SELECT * FROM TeamSettings WHERE OrgId = '987654321' AND TeamId = '3074457361234567890'

DefaultTeamSettings:

SELECT * FROM DefaultTeamSettings WHERE OrgId = '987654321'

ProjectMembers:

SELECT * FROM ProjectMembers WHERE OrgId = '987654321' AND TeamId = '3074457361234567890' AND ProjectId = '1234567890'

ProjectSettings:

SELECT * FROM ProjectSettings WHERE OrgId = '987654321' AND TeamId = '3074457361234567890' AND ProjectId = '1234567890'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property Description
APIKey The API Key used to authenticate to Miro.
AuthScheme The scheme used for authentication. Accepted entries are APIKey or None.
Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0