Skip to main content
Needs backend verification (audit 2026-05): The header name and base URL on this page may be out of date.
  • Auth header: docs show x-api-key; frontend uses x-bitbybit-key. Until confirmed (Satrio: see BBB2-5510), try both.
  • Base URL: docs show customer/open/v1; the customers OpenAPI spec was updated to customer/api/open/v1 in commit 5c4126c. The introduction prose may be stale.
If you hit 401 or a 404 on the base URL, this is why.

​
Overview

The bitbybit Open API provides programmatic access to your bitbybit data. You can manage customers, orders, and products through a RESTful API secured with API key authentication.

​
Base URLs

ServiceBase URL
Customers, Orders, Productshttps://api.bitbybit.studio/customer/open/v1
Messaginghttps://api.bitbybit.studio/whatsapp/open/v1

​
Quick Start

  1. Go to Settings > Developer in your bitbybit dashboard
  2. Click Create API Key and select the scopes you need
  3. Copy the API key (it’s only shown once)
  4. Include it in every request via the x-api-key header
curl -X GET "https://api.bitbybit.studio/customer/open/v1/customers" \
  -H "x-api-key: bbb_live_your_api_key_here"

​
Response Format

Success (single resource): 
{
  "data": { ... }
}
Success (collection): 
{
  "data": [ ... ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 100,
    "hasNextPage": true
  }
}
Error: 
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Customer not found"
  }
}

​
Available Resources

Customers

Create, read, update, and delete customers

Orders

Manage orders and fulfillment

Products

Manage your product catalog

Messaging

Send and track WhatsApp messages

Loyalty

Manage loyalty settings, points, rewards, and redemptions

Webhooks

Receive real-time event notifications