Getting started

bsport Public API is designed for partner integrations that act on behalf of your company or franchise team. During the Beta test phase, access is granted by the bsport team. Direct REST integrations use API key authentication. Approved users can also connect compatible AI assistants through MCP and OAuth.

These REST examples use V2. V1 remains a separate contract and retires on January 15, 2027; changing only the URL is not a migration strategy. See Migrate from V1 to V2 and the data model and terminology and Data model and terminology (V1).

What you can do

Use the API to automate operational workflows, such as managing clients, creating bookings, and querying billing information. All actions are performed in the context of a company or franchisor.

Which version each surface uses

Read the table by surface. The version decides which field names and IDs you receive.

Surface	Version	What it means for you
REST API	V2 for new integrations. V1 is available until January 15, 2027	Use /api/v2/. See V2 workflows and field conventions
Webhook payloads	V2 for new registrations. Existing registrations stay on V1	New registrations use V2 event names and data follows the V2 response. See Webhook event payloads
MCP	V2	Tools expose V2 management operations. See the MCP overview

Prerequisites

For a direct REST integration, you need:

• An API key issued by the bsport team.
• Your X-Client-ID value (used for tracing and support).
• The company or franchisor identifier you will operate on.
• The base URL for your environment (see below).

Getting your API key and identifiers

During the Beta test phase, please contact the bsport team to receive your API key, client ID, and company ID.

For an MCP connection, you need:

• A bsport user account with MCP access.
• The identifier of a company that user can access.
• A compatible AI client.

MCP uses OAuth and does not require a Public API key or X-Client-ID. See Connect an AI assistant with MCP for the production URL and client-specific instructions.

Environments

Every endpoint path in this documentation is relative to one of these base URLs. Code samples use YOUR_ENV_DOMAIN as a placeholder: replace it with the base URL for the environment you are targeting.

Environment	Base URL	Use it for
Staging	https://public.staging.bsport.io	Building and testing your integration against non-production data.
Production	https://public.production.bsport.io	Live integrations.

API keys are environment-specific. A staging key does not authenticate against production, and the company identifiers differ between the two. Build and validate against staging first, then request production credentials from the bsport team.

First REST request

Start with a ping request to verify connectivity and headers.

curl -X GET \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Client-ID: YOUR_CLIENT_ID' \
  -H 'X-Company-ID: YOUR_COMPANY_ID' \
  'https://YOUR_ENV_DOMAIN/api/v2/monitoring/health/ping/'

Replace YOUR_ENV_DOMAIN with public.staging.bsport.io (staging) or public.production.bsport.io (production). See Environments.

If the request succeeds, your REST integration is ready to use the guides and API reference.

Next steps

Follow the guides in this order.

1. Authentication and Headers and tenant context
2. Data model and terminology: the objects and how they relate
3. Pagination and filtering, Errors and status codes and Rate limits and bulk data sync
4. V2 workflows and field conventions: task guides
5. Webhook event payloads and the Webhooks overview
6. Connect an AI assistant with MCP and Using LLMs for custom integrations
7. Coming from V1: Migrate from V1 to V2

Ask an AI assistant about these docs

llms.txt lists these guides, the OpenAPI files and the changelog in the llms.txt format, a plain-text index written for AI assistants. Each guide also has a Markdown version: replace .html with .md in its URL. If your assistant can fetch web pages, give it the llms.txt URL and ask your question.