Call your API

Once you have credentials, you are ready to send your first request. This topic covers the anatomy of a Boomi API call so you can apply it to any Boomi service area.

Prerequisites

Before you call a Boomi API, make sure you have:

• Valid credentials for the service area you plan to use. Refer to Authenticating your API.
• Your Boomi account ID. For Platform and most other APIs, find it in Settings > Account > Account Information.
• The base URL and endpoint path for the operation you want to perform, from the relevant API reference.

Base URLs by service area

Boomi API base URLs vary by service area and region. The following are the most common patterns:

Service area	Base URL (US)	Base URL (GB)
Platform REST API	https://api.boomi.com/api/rest/v1/{accountId}	https://api.platform.gb.boomi.com/api/rest/v1/{accountId}
Platform SOAP API	https://api.boomi.com/api/soap/v1/{accountId}	https://api.platform.gb.boomi.com/api/soap/v1/{accountId}
GraphQL API	https://api.boomi.com/graphql	https://api.platform.gb.boomi.com/graphql
Data Integration API	Regional endpoint provided with your Data Integration account	-
MFT API	Regional Swagger/API endpoint (US, UK, EU, or AU)	-

Check the specific API reference topic for the exact base URL and path of the operation you want to call.

Anatomy of a request

Every Boomi API request generally includes:

• Method - GET, POST (CREATE), UPDATE, DELETE, or an action such as QUERY or execute, depending on the API.
• Authentication header - A Basic Auth header (user name and API token or password) or a Authorization: Bearer <token> header (JWT or Data Integration/MFT token). Refer to Authenticating your API.
• Content-Type header - application/json for JSON payloads, or application/xml for XML (the default for Platform REST/SOAP requests).
• Accept header - application/json to receive a JSON response, otherwise responses default to XML for Platform APIs.
• Request body - Required for CREATE, UPDATE, QUERY, and action-based operations. Not required for simple GET requests.

Example: calling the Platform API

The following example retrieves a component from a Boomi Enterprise Platform account using an API token:

curl --user "BOOMI_TOKEN.user@boomi.com:123aab45-67b8-9012-3a45-67c8e9e01e23" \
  --request GET 'https://api.boomi.com/api/rest/v1/{accountId}/Component/{componentId}'

A successful call returns an HTTP 200 response with the requested data in the response body.

Regional endpoints

Boomi hosts APIs in multiple regions. Replace the US base URL host (api.boomi.com) with the appropriate regional host, such as api.platform.gb.boomi.com for the GB region, when your account is hosted outside the US.

Next steps

After you send a request, refer to Test your API to verify the response and troubleshoot common issues.