Bual Pro API reference

Use the Bual Pro API to work with your account and contact data, send messages and flows, and manage supported business resources.

Base URL

https://app.bualpro.com/api

Authentication

Send your API token in the X-ACCESS-TOKEN header. See Authentication for the request format.

Explore the endpoints

The reference contains 65 operations across seven groups:

• Accounts: account details, admins, teams, tags, flows, custom fields, bot fields, integrations, and template links.
• Contacts: contact details, tags, custom fields, messages, and flows.
• Pipelines: pipelines, stages, opportunities, and comments.
• AI agents: agents, functions, MCP connections, and files.
• Templates: install an account template.
• Appointments: calendars and calendar details.
• Ecommerce: products, carts, orders, and product messages.

Each endpoint shows its HTTP method, route, documented parameters, and response schemas. Read the contract notes before integrating where the source has missing or inconsistent definitions.

Request examples and the playground

Replace placeholder values with your own account's identifiers and token. The playground sends real API requests when you run it. Review the selected method, endpoint, and values first, especially for sends, updates, deletions, and order actions.

Response examples generated from schemas illustrate structure. They are not captured API responses. No request needs to be run to read this reference.

The original Swagger UI remains available. This reference follows its API version 1.1, checked on 20 October 2026.

Additional beta tools reference

The original Tools API Swagger reference lists a separate set of 17 beta utility operations. Those operations are outside the 65-operation reference above. Review that source and its contract before using a utility; no tool request has been executed to validate its behavior here.