Section 8 of 12
Integrations & API
Integrate Buqq with your POS or custom tooling via the external REST API.
The Integrations section provides an external REST API for building custom integrations with your POS or other tools. Access it from Dashboard → Integrations.
Merchant ID#
Your Merchant ID is a unique identifier for your account within the Buqq platform. It is shown on the Integrations page and is required when contacting support or using certain API endpoints.
API keys#
The Buqq external API lets you read availability, create bookings, and update booking statuses from your own systems. API access requires an API key associated with your merchant account.
Generating a key
- In Dashboard → Integrations, scroll to "API Keys".
- Click "Generate API key".
- Copy the key and store it in your environment variables or secrets manager.
Revealing the current key
If you need to retrieve your existing key, click Reveal — the full key is displayed so you can copy it again.
Rotating a key
Rotating replaces your current key with a new one. The old key is immediately invalidated. Update any integrations using the old key before rotating.
Revoking a key
Revoking deletes the current key without issuing a new one. API calls will fail until you generate a new key. Use revoke if you suspect a key has been compromised.
cURL snippets#
The Integrations page shows ready-to-use cURL snippets for the most common API operations. Replace YOUR_API_KEY with your actual key to test immediately.
EXAMPLE — Check availability
curl https://buqq.online/api/external/v1/availability \ -H "Authorization: Bearer YOUR_API_KEY" \ -G -d "date=2025-08-15" -d "party_size=2"
POS notes#
If you are connecting Buqq to a point-of-sale system, the external API supports reading today's confirmed bookings and updating statuses (e.g. marking a booking as checked-in or cancelled) from your POS. Consult your POS vendor's documentation for their specific integration steps, and refer to the API docs for endpoint details.
- GET /api/external/v1/availability
- Returns available slots for a given date and party size.
- GET /api/external/v1/bookings
- Lists bookings for your restaurant. Filter by date.
- POST /api/external/v1/bookings
- Creates a new booking programmatically.
- PATCH /api/external/v1/bookings/{id}/status
- Updates a booking status (confirmed, checked_in, cancelled, no_show).