API overview

Boomi provides a broad set of APIs so you can automate the work you would otherwise do in the Boomi Enterprise Platform user interface, integrate Boomi with your own systems, and build on top of Boomi capabilities such as integration, data movement, golden-record management, managed file transfer, and AI agents.

This Getting Started guide walks you through the basics of working with Boomi APIs.

Select a step to learn more:

• Find the right API - Identify which API matches your use case.
• Authenticating your API - Set up credentials for the API you plan to use.
• Call your API - Learn the anatomy of a Boomi API request and send your first call.
• Test your API - Verify your calls and troubleshoot common issues using Postman or Swagger.

The following are reference topics that apply across Boomi APIs:

• Core terms and concepts - Reference glossary of terms used across Boomi APIs.
• API licensing - Review usage limits and licensing requirements.
• API errors - Understand standard HTTP status codes and error responses.
• Feature release stages - Understand support and access levels across the platform feature lifecycle.

Boomi service areas and their APIs

Each Boomi service area has its own APIs and API reference. Authentication requirements can vary by API.

• Platform - Supports REST, SOAP, and GraphQL APIs that automate the work you normally do in the Boomi Enterprise Platform user interface, including managing components, connections, environments, Runtimes, and deployments.
• GraphQL - Supports a single-endpoint query language across multiple service areas, including Platform, Bundles, Event Streams, Partner Portal, Agent Control Tower, and API Metrics, so you can request exactly the data you need.
• Data Integration - Supports APIs that automate Data Flows, DataFrames, and other Data Integration console operations.
• Managed File Transfer (MFT) - Supports APIs that automate file transfer endpoints, flows, and administration tasks.
• Connectors - Supports APIs that manage connector development, deployment, and versioning resources.
• Agentstudio - Supports APIs that create, configure, and run AI agents.
• Data Hub - Supports APIs that manage models, sources, and golden records.
• Bundles - Supports APIs that package and promote assets across environments.
• Audit Log Staging - Supports APIs that retrieve audit events and operational history.
• Event Notifications - Supports APIs that subscribe to platform event notifications.

If you are not sure which API fits your use case, refer to Find the right API.

Get started

Every Boomi API call requires valid credentials. Start with Authenticating your API to set up the authentication method that applies to the API you plan to use.