API Reference
Comprehensive reference for the ToolBox API and Dataverse API available to all tools running in Power Platform ToolBox.
For complete TypeScript definitions, install the @pptb/types package: bash npm install --save-dev @pptb/types
Overview
Power Platform ToolBox provides a comprehensive set of APIs that enable tool developers to create powerful, integrated experiences. These APIs are organized into several categories, each serving a specific purpose:
- ToolBox API - Platform features including connections, utilities, and terminal management
- Dataverse API - Complete HTTP client for interacting with Microsoft Dataverse
- Settings API - Persistent storage for tool-specific preferences and configuration
- File System API - Secure file operations for reading, writing, and managing files
- Events API - Subscribe to platform events like connection changes and settings updates
- Error Handling - Best practices for handling errors gracefully
Quick Links
Getting Started
For developers new to Power Platform ToolBox, we recommend starting with:
- Quickstart Guide - Get up and running quickly
- ToolBox API - Learn about platform features
- Dataverse API - Start interacting with Dataverse
- Error Handling - Implement robust error handling