The MarketBox API follows standard REST conventions and returns JSON responses. It uses predictable resource URLs, standard HTTP verbs and response codes and token-based authentication over HTTPS.
At a high level, the API provides both the availability intelligence powered by the Smart Clusters engine and the underlying resources needed to support booking, scheduling and operational workflows. This allows teams to embed optimized availability logic into existing systems or build new workflows on top of MarketBox infrastructure.
The MarketBox API does not support bulk updates. Each request operates on a single object, which helps keep availability calculations and operational state consistent.
Resources vs Tools
The MarketBox API is divided into two sections: “Resources” and “Tools”.
Resources represent the core object entities within the MarketBox platform. These include orders, bookings, services, providers, schedules, clients and other related records. Together, these resources form the operational data model used by booking engines, dispatcher workflows and downstream systems. For example, creating an order typically requires references to a provider, a client, a service and an associated schedule.
Tools represent API-driven utilities powered by the Smart Clusters engine. These tools apply availability intelligence to resource data to answer questions such as when work can realistically be scheduled, which providers are eligible and how bookings fit into an existing day.
While many integrations use Resources and Tools together, they are intentionally decoupled. You can manage data using Resources alone, invoke availability intelligence using Tools alone or combine both depending on your chosen integration pattern.
Authentication
The MarketBox API uses API keys to authenticate requests. You can view and manage your API keys in the MarketBox admin console.
API keys grant access to availability intelligence and operational resources, so they should be stored securely. Do not expose secret keys in client-side code or public repositories.
All API requests must be made over HTTPS. Requests made over plain HTTP will fail. Requests without valid authentication will also fail.
Getting started
We are currently building a self-serve onboarding flow that will allow developers to create an account and generate API keys automatically.
Until that flow is available, please email support@gomarketbox.com and our team will provision your account and API keys so you can begin testing Smart Clusters and the MarketBox API.